cb3ddd533f
* 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 file or stdout by @ananthb in https://github.com/browsh-org/browsh/pull/493 * feat: Structured log messages by @ananthb in https://github.com/browsh-org/browsh/pull/494 * chore: Clean up SETUP guides by @ananthb in https://github.com/browsh-org/browsh/pull/495 * chore: Remove manual install steps by @ananthb in https://github.com/browsh-org/browsh/pull/496 * fix: If debug is false discard logs by @ananthb in https://github.com/browsh-org/browsh/pull/497 * [Fix] Firefox inspecting logic on Windows by @Dragon1573 in https://github.com/browsh-org/browsh/pull/502 * feat: Add json schema (#505) by @Freed-Wu in https://github.com/browsh-org/browsh/pull/510 * @lpmi-13 made their first contribution in https://github.com/browsh-org/browsh/pull/466 * @ananthb made their first contribution in https://github.com/browsh-org/browsh/pull/493 * @Dragon1573 made their first contribution in https://github.com/browsh-org/browsh/pull/502 * @Freed-Wu made their first contribution in https://github.com/browsh-org/browsh/pull/510 |
||
|---|---|---|
| .github | ||
| interfacer | ||
| scripts | ||
| webext | ||
| .dockerignore | ||
| .eslintrc | ||
| .gitignore | ||
| .nvmrc | ||
| ctl.sh | ||
| Dockerfile | ||
| goreleaser.yml | ||
| LICENSE | ||
| README.md | ||
| SETUP_DEV_LINUX.md | ||
| SETUP_DEV_OSX.md | ||
| SETUP_DEV_WIN.md | ||
A fully interactive, real-time, and modern text-based browser rendered to TTYs and browsers
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
- @tobimensch For essential early feedback and user testing.
- @arasatasaygin For the Browsh logo.
Donating
Please consider donating: https://www.brow.sh/donate
License
GNU Lesser General Public License v2.1