git clone browsh-org-browsh_-_2018-07-09_06-02-22.bundle -b master
A fully interactive, realtime and modern text-based browser rendered to TTYs and browsers
Not all the world has good Internet.
If all you have is a 3kbps connection tethered from a phonethen it's good to SSH into a server and browse the web through, say,elinks. That way theserver downloads the web pages and uses the limited bandwidth of anSSH connection to display the result. But traditional text-based browserslack JS support and all that other modern HTML5 goodness. Browsh is differentin that it's backed by a real browser, namely headless Firefox, and uses thatto create purely text-based version of web pages and web apps that can be easilyrendered in a terminal or indeed, somewhat ironically, in another browser. Though 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 quitehave the same ability to deal with extremely bad Internet. Also,terminal Browsh can use MoSH to further reduce bandwidth and increase stabilityof the connection. Mosh offers features like automaticreconnection of dropped or roamed connections and diff-only screen updates.Furthermore, other than SSH or MoSH, terminal Browsh doesn't require a clientlike VNC.
One final reason to use terminal Browsh could be to offload the battery-drain of a modernbrowser 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 life if your CPU-hungry browseris running somehwere else on mains electricity.
Download a binary from the releases (~2-6MB).You will need to have Firefox >=57 aleady installed.
Or download and run the Docker image (~230MB) with:
docker run -it browsh/browsh
Most keys and mouse gestures should work as you'd expect on a desktopbrowser.
For full documentation see the documentation.
To setup a dev env you will need NodeJS and Golang installed. If you get stucksetting up your env, take a look in
.travis.yml, it has to setup everythingfrom scratch for every push to Github.
I'd recommend nvm for NodeJS - note that
nvm install will automatically parse the
.nvmrc version in this repo to getthe correct NodeJS version. For Golang it's probably best to just use your OS'spackage manager. The current Golang version being used is stored in
You'll then need to install the project dependencies. For the webextension, justrun:
npm install inside the
webext/ folder. For the CLI client you will firstneed to install
dep, there is a script for this in
interfacer/contrib/setup_go.sh.I don't fully understand Golang's best practices, but it seems you are forced tokeep your Go project's code under
$GOPATH/src, you might be able to get awaywith symlinks. Anyway, to install the dependencies use:
dep ensure inside the
Then the ideal setup for development is: * have Webpack watch the JS code so that it rebuilds automatically:
webpack --watch * run the CLI client without giving it the responsibility to launch Firefox:
go run ./interfacer/src/main.go -use-existing-ff -debug * have Mozilla's handy
web-ext tool run Firefox and reinstall the webextension everytime webpack rebuilds it: (in
web-ext run --verbose
For the webextension: in
For CLI unit tests: in
go test src/browsh/*.go
For CLI E2E tests: in
go test test/tty/*.go
For HTTP Service tests: in
go test test/http-server/*.go
GNU General Public License v3.0