browsh-org /browsh
A fully-modern text-based browser, rendering to TTY and browsers
★ 19,128⑂ 480👁 182⑃ 105● 439▤ 44
+0
日增长
19,128
stars
480
forks
182
watchers
105
prs
439
issues
44
releases
README
!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.
Development
The Firefox Web Extension
This is needed to run essential JS inside web pages so that they render in a way that Browsh can consume.
You will need to install nodejs, usually available from your OS package manager. Though for development purposes the recommended method is with https://mise.jdx.dev.
Then in the webext directory
npm install
npx webpack --watch
The browsh Golang code
You will need to install go, usually available from your OS package manager. Though for development purposes the recommended method is with https://mise.jdx.dev.
Then in the interfacer directory
go run ./cmd/browsh --debug
Logs will be available in interfacer/debug.log
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
@tobimensch For essential early feedback and user testing.
@arasatasaygin For the Browsh logo.
DonTop issues
#77Vertical lines through all content66 comments · 2018-07-10#446Ubuntu x64 fresh install returns panic runtime error30 comments · 2022-10-03#31Vim mode30 comments · 2018-06-12#67Windows binary contains a Virus?25 comments · 2018-07-09#404Poor colour rendering on Windows - with a TrueColor terminal25 comments · 2022-03-20#86Support libsixel for rendering?23 comments · 2018-07-10#190How can we get this project thriving?22 comments · 2018-08-27#52Tabbing should navigate input boxes20 comments · 2018-06-22
Discussions
#569Console write problems3 comments · 2026-06-02#561Using ChatGPT with browsh0 comments · 2025-10-29#558There was an error1 comments · 2025-10-14#557How can i increase resolution2 comments · 2025-10-01#541What is the latest Firefox version supported by Browsh 1.8.3?1 comments · 2025-03-18#539Cannot click on cookies and captcha/not visible available to click on some pages0 comments · 2025-02-06#538Is it possible to use gui with librewolf1 comments · 2025-02-06#533Windows 10/11 Install Scripts for browsh0 comments · 2024-11-03
Latest release
v1.8.3 v1.8.3 2024-01-29What's Changed Bump fast-json-patch and web-ext in /webext by @dependabot in https://github.com/browsh-org/browsh/pull/461 Bump loader-utils from 2.0.2 to 2.0.4 in /webext by @dependabot in https://github.com/browsh-org/browsh/pull/453 remove unnecessary RUN command by @lpmi-13 in https://github.com/browsh-org/browsh/pull/466 Bump http-cache-semantics from 4.1.0 to 4.1.1 in /webext by @dependabot in https://github.com/browsh-org/browsh/pull/467 fix: Golang install: use "amd64" for "x86_64" by @tombh in https://github.com/browsh-org/browsh/pull/463 feat: Use log/slog for logging to