A fully-modern text-based browser, rendering to TTY and browsers

Thomas Buckley-Houston cb3ddd533f build: release v1.8.3 1 month ago
.github c191b34201 feat: Structured log messages 3 months ago
interfacer cb3ddd533f build: release v1.8.3 1 month ago
scripts d32ae0ba5a fix: Golang install: use "amd64" for "x86_64" 1 year ago
webext 200aec095d feat: Add json schema (#505) 2 months ago
.dockerignore 2985774859 Automate releases 6 years ago
.eslintrc d2aaa33963 Refactored webext background script 6 years ago
.gitignore 3bc427f416 devops: Update release process for Github 1 year ago
.nvmrc 1f20113bc0 chore: Update .nvmrc to Node 16 1 year ago
Dockerfile 0cef277365 remove unnecessary RUN command 1 year ago
LICENSE e048fc8d6a Changed license to LGPLv2 5 years ago
README.md 3bc427f416 devops: Update release process for Github 1 year ago
SETUP_DEV_LINUX.md 65344c3f80 chore: Remove manual install steps 3 months ago
SETUP_DEV_OSX.md f93a4d12cf feat: Use log/slog for logging to file or stdout 3 months ago
SETUP_DEV_WIN.md f9c6fcf4cc chore: Clean up SETUP guides 3 months ago
ctl.sh 3bc427f416 devops: Update release process for Github 1 year ago
goreleaser.yml 3bc427f416 devops: Update release process for Github 1 year ago

README.md

Browsh Logo

A fully interactive, real-time, and modern text-based browser rendered to TTYs and browsers

Browsh GIF

Why use Browsh?

Not all the world has good Internet.

If you only have a 3kbps internet connection tethered from a phone, then it's good to SSH into a server and browse the web through, say, elinks. That way the server downloads the web pages and uses the limited bandwidth of an SSH connection to display the result. However, traditional text-based browsers lack JS and all other modern HTML5 support. Browsh is different in that it's backed by a real browser, namely headless Firefox, to create a purely text-based version of web pages and web apps. These can be easily rendered in a terminal or indeed, ironically, in another browser. Do note that currently the browser client doesn't have feature parity with the terminal client.

Why not VNC? Well VNC is certainly one solution but it doesn't quite have the same ability to deal with extremely bad Internet. Terminal Browsh can also use MoSH to further reduce bandwidth and increase stability of the connection. Mosh offers features like automatic reconnection of dropped or roamed connections and diff-only screen updates. Furthermore, other than SSH or MoSH, terminal Browsh doesn't require a client like VNC.

One final reason to use terminal Browsh could be to offload the battery-drain of a modern browser from your laptop or low-powered device like a Raspberry Pi. If you're a CLI-native, then you could potentially get a few more hours of life if your CPU-hungry browser is running somewhere else on mains electricity.

Installation

Download a binary from the releases (~11MB). You will need to have Firefox already installed.

Or download and run the Docker image (~230MB) with:

`docker run --rm -it browsh/browsh`

Usage

Most keys and mouse gestures should work as you'd expect on a desktop browser.

For full documentation click here.

Contributing

Note that some of these instructions may be out of date (July 2022)

For generic Linux systems you can follow this guide on how to setup a build environment, that you may be able to adapt for other systems as well.

Windows users can follow this guide in order to set up a build environment.

Mac users may follow this guide that goes through the steps of setting up a build environment.

Communication

Questions about Brow.sh? Stuck trying to resolve a tricky issue? Try:

Tests

For the webextension: in webext/ folder, npm test
For CLI unit tests: in /interfacer run go test src/browsh/*.go
For CLI E2E tests: in /interfacer run go test test/tty/*.go
For HTTP Service tests: in /interfacer run go test test/http-server/*.go

Special Thanks

Donating

Please consider donating: https://www.brow.sh/donate

License

GNU Lesser General Public License v2.1