Skip to content

Latest commit

 

History

33 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Latest Version CICD Go version Go Report Card Go Reference

Static Badge BrowseTerm

A minimal web browser for your terminal.

Browse-Term Preview

Installation

Prerequisites

  • A Nerd Font (recommended)
  • A Chromium browser installed (optional, for JavaScript execution)

Install with Go (Recommended)

Install the latest version with the Go CLI.

go install github.com/austin-weeks/browse-term@latest

Install a Pre-Built Binary

Alternatively, you can download a pre-built binary from releases.

Usage

Start BrowseTerm:

browse-term

See the help line at the bottom of the viewport for available keyboard navigation.

JavaScript Execution

By default, BrowseTerm uses Chromium to execute JavaScript on page load. This allows you to view content from sites that rely heavily on JavaScript for rendering the initial page.

You can disable JavaScript with the --no-js flag:

browse-term --no-js

Configuration

BrowseTerm can be configured via a yaml file.

On startup, it will look for a config file at ~/.config/browse-term/config.yaml

Example config.yaml

theme: catppuccin-mocha

Options

Name Description Choices Default
theme Sets the color scheme dark, light, tokyo-night, pink, dracula, catppuccin-latte, catppuccin-frappe, catppuccin-macchiato, catppuccin-mocha tokyo-night

Project Roadmap

  • HTML as rendered markdown
  • Navigation keybinds
  • Tree for page links
  • JavaScript execution on page load
  • Theme Configuration
  • Page history & navigation
  • Image Rendering
  • Prebuilt Binaries in Releases

Contributing

Contributions are welcome! Please open an issue for feature requests or bug reports.

About

Browse the web in your terminal!

Topics

Resources

Stars

4 stars

Watchers

0 watching

Forks

Releases

Contributors

Languages