https://github.com/browsh-org/browsh Skip to content Sign up * Product + Features + Mobile + Actions + Codespaces + Packages + Security + Code review + Issues + Integrations + GitHub Sponsors + Customer stories * Team * Enterprise * Explore + Explore GitHub + Learn and contribute + Topics + Collections + Trending + Learning Lab + Open source guides + Connect with others + The ReadME Project + Events + Community forum + GitHub Education + GitHub Stars program * Marketplace * Pricing + Plans + Compare plans + Contact Sales + Education [ ] * # In this repository All GitHub | Jump to | * No suggested jump to results * # In this repository All GitHub | Jump to | * # In this organization All GitHub | Jump to | * # In this repository All GitHub | Jump to | Sign in Sign up {{ message }} browsh-org / browsh Public * * Notifications * Fork 428 * Star 14.6k A fully-modern text-based browser, rendering to TTY and browsers www.brow.sh License LGPL-2.1 license 14.6k stars 428 forks Star Notifications * Code * Issues 181 * Pull requests 18 * Actions * Projects 1 * Wiki * Security * Insights More * Code * Issues * Pull requests * Actions * Projects * Wiki * Security * Insights This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository. master Switch branches/tags [ ] Branches Tags Could not load branches Nothing to show {{ refName }} default View all branches Could not load tags Nothing to show {{ refName }} default View all tags 16 branches 50 tags Code Latest commit @gregsadetsky @tombh gregsadetsky and tombh Fix Mac Build Environment Documentation ... 64c68a9 May 24, 2022 Fix Mac Build Environment Documentation 64c68a9 Git stats * 390 commits Files Permalink Failed to load latest commit information. Type Name Latest commit message Commit time .github Add Patreon to Github's sponsor button Jun 18, 2019 contrib Fix Mac Build Environment Documentation May 24, 2022 interfacer Added in Ctrl+U option for view-source (#355) Dec 28, 2020 webext Bump lodash from 4.17.13 to 4.17.19 in /webext (#333) Jul 27, 2020 .dockerignore Automate releases Jan 28, 2018 .eslintrc Refactored webext background script Jan 10, 2018 .gitignore Refactor build process to not use pre-built bins Jul 26, 2018 .nvmrc Upgrade NodeJS to 10.7.0 Jul 27, 2018 .travis.yml Bring Go current in Travis (#292) Nov 19, 2019 Dockerfile Centralise all the Browsh build steps Jul 26, 2018 LICENSE Changed license to LGPLv2 Jul 17, 2018 README.md Add donation link to README Sep 2, 2020 View code [ ] Why use Browsh? Installation Usage Contributing Communication Building a Browsh release Tests Special Thanks Donating License README.md Build Status Follow @brow_sh 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 (~7MB). You will need to have Firefox 63 (or higher) 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 To setup a development environment you will need NodeJS and Golang installed. If you get stuck setting up your environment, take a look in .travis.yml, it has to setup everything from 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 get the correct NodeJS version. For Golang it's probably best to just use your OS's package manager. The current Golang version being used is stored in .travis.yml. You'll then need to install the project dependencies. For the webextension, just run: npm install inside the webext/ folder. For the CLI client you will first need to install dep, there is a script for this in interfacer/contrib/setup_dep.sh. I don't fully understand Golang's best practices, but it seems you are forced to keep your Go project's code under $GOPATH/src, you might be able to get away with symlinks. Anyway, to install the dependencies use: dep ensure inside the interfacer/ folder. 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 --firefox.use-existing --debug * have Mozilla's handy web-ext tool run Firefox and reinstall the webextension every time webpack rebuilds it: (in webext/dist) web-ext run --verbose 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? Connect with the Brow.sh community on Gitter! Building a Browsh release If you'd like to build Browsh for a new package manager, or for any other reason, you can use the script at interfacer/contrib/ build_browsh.sh as a guide. Note you won't be able to build the web extension as Mozilla only allows one canonical version of web extensions per version number. So the build script downloads the official web extension .xpi file from the Mozilla archives. 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 About A fully-modern text-based browser, rendering to TTY and browsers www.brow.sh Topics ssh tty vnc mosh http-performance bandwidth-saver Resources Readme License LGPL-2.1 license Stars 14.6k stars Watchers 196 watching Forks 428 forks Releases 41 v1.6.4 Latest Jun 19, 2019 + 40 releases Sponsor this project * patreon patreon.com/browsh Packages 0 No packages published Contributors 29 * @tombh * @tobimensch * @CodyGramlich * @j-rewerts * @farhadmak * @dependabot[bot] * @xv-tom-bh * @Yash-Singh1 * @ovidr * @ss18 * @rahimnathwani + 18 contributors Languages * JavaScript 46.9% * Go 45.7% * Shell 3.7% * HTML 1.2% * CSS 1.0% * Dockerfile 0.8% * Python 0.7% * (c) 2022 GitHub, Inc. * Terms * Privacy * Security * Status * Docs * Contact GitHub * Pricing * API * Training * Blog * About You can't perform that action at this time. You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.