https://github.com/austin-weeks/browse-term

Browse the web in your terminal!
https://github.com/austin-weeks/browse-term

browser go terminal tui web

Last synced: 4 months ago
JSON representation

Browse the web in your terminal!

• Host: GitHub
• URL: https://github.com/austin-weeks/browse-term
• Owner: austin-weeks
• License: gpl-3.0
• Created: 2025-10-26T19:55:58.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2025-11-29T04:26:36.000Z (7 months ago)
• Last Synced: 2025-11-29T08:21:41.851Z (7 months ago)
• Topics: browser, go, terminal, tui, web
• Language: Go
• Homepage:
• Size: 5.44 MB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
![Latest Version](https://img.shields.io/github/v/tag/austin-weeks/browse-term?label=latest)

![CICD](https://github.com/austin-weeks/browse-term/actions/workflows/CICD.yaml/badge.svg)

![Go version](https://img.shields.io/github/go-mod/go-version/austin-weeks/browse-term)

[![Go Report Card](https://goreportcard.com/badge/github.com/austin-weeks/browse-term)](https://goreportcard.com/report/github.com/austin-weeks/browse-term)

[![Go Reference](https://pkg.go.dev/badge/github.com/austin-weeks/browse-term.svg)](https://pkg.go.dev/github.com/austin-weeks/browse-term)

#  BrowseTerm

A minimal web browser for your terminal.

![Browse-Term Preview](./.github/images/preview.gif)

## Installation

### Prerequisites

- A [Nerd Font](https://www.nerdfonts.com/) (recommended)

- A Chromium browser installed (optional, for JavaScript execution)

### Install with Go (Recommended)

Install the latest version with the [Go](https://go.dev/doc/install) CLI.

```bash

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

```

### Install a Pre-Built Binary

Alternatively, you can download a pre-built binary from [releases](https://github.com/austin-weeks/browse-term/releases).

## Usage

Start BrowseTerm:

```bash

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:

```bash

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`

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

- [x] HTML as rendered markdown

- [x] Navigation keybinds

- [x] Tree for page links

- [x] JavaScript execution on page load

- [x] Theme Configuration

- [ ] Page history & navigation

- [ ] Image Rendering

- [x] Prebuilt Binaries in Releases

## Contributing

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