browse-term

command module
v0.1.26 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 15, 2026 License: GPL-3.0 Imports: 11 Imported by: 0

README

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 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.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
internal
browser
Package browser provides methods for fetching websites for display in browse-term.
Package browser provides methods for fetching websites for display in browse-term.
config
Package config provides configuration functionality for browse-term.
Package config provides configuration functionality for browse-term.
themes
Package themes specifies themes for browse-term.
Package themes specifies themes for browse-term.
tui
Package tui - browse-term's terminal user interface.
Package tui - browse-term's terminal user interface.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL