browsh
Browse the web via text-based interface
TLDR
Start browsh
Start browsh in a specific webpage
Focus URL bar
Exit browsh
Display help
SYNOPSIS
browsh [options] [URL]
PARAMETERS
-v, --version
Display the version number and exit.
-h, --help
Display help information and exit.
[URL]
Open the specified URL in Browsh. If omitted, Browsh starts with a blank page.
--http-server-addr
Set the address of the HTTP server interface (for remote control). Defaults to 127.0.0.1.
--http-server-port
Set the port of the HTTP server interface. Defaults to 4321.
--xvfb
Use a virtual X frame buffer (xvfb) if no graphical environment is available.
DESCRIPTION
Browsh is a fully-modern text-based browser that renders anything that a modern browser can, within a terminal emulator. It does this by utilizing a headless browser (Firefox) to create a purely text-based version of a website. This allows users to access the web on remote servers, over low-bandwidth connections, or in environments where a graphical interface is unavailable. Browsh supports modern web technologies like HTML5, CSS3, JavaScript, and even video playback through a terminal-based video player.
Browsh is particularly useful for accessing websites from SSH sessions, viewing web pages on servers without a GUI, or simply for conserving bandwidth when browsing the web. Its text-based output makes it a suitable choice for screen readers and other assistive technologies.
Its core features are: fully capable web browsing inside a terminal, low bandwidth usage, accessibility via screen readers and VNC.
CAVEATS
Browsh relies on a headless browser (Firefox) which consumes system resources. Performance may be impacted on resource-constrained systems. Certain complex websites may not render perfectly in text format. Requires Firefox to be installed. Make sure the browsh repository is up to date before use.
KEYBOARD SHORTCUTS
Ctrl+L: Go to URL.
Ctrl+R: Reload page.
Ctrl+H: Show history.
Ctrl+J: Show downloads.
Ctrl+Q: Quit Browsh.
Arrow keys: Scroll the page.
Page Up/Down: Scroll the page fast.
g/G: Go to the top/bottom.
CONFIGURATION
Browsh's behavior can be configured through environment variables, which allow you to customize various aspects such as HTTP proxy settings, font rendering, and default URL. Consult the Browsh documentation for a full list of configuration options.
REMOTE ACCESS
Browsh can be accessed remotely through its HTTP server interface. This allows you to control Browsh from a remote machine via a web browser or other client. See '--http-server-addr' and '--http-server-port' parameters.
HISTORY
Browsh was created to provide a modern web browsing experience within a text-based environment. It addresses the limitations of older text-based browsers by leveraging the capabilities of a headless Firefox instance. Its development focused on accessibility, low-bandwidth usage, and remote server access. The project has evolved over time with ongoing improvements to rendering accuracy and feature support.