terminal-browser is a free, open source browsers & extensions project written in TypeScript and released under MIT. It has 3,081 GitHub stars, 145 forks and 64 open issues, and was last pushed 27 hours ago. On this registry it ranks #80 of 133 tracked projects in Browsers & Extensions, with 5 head-to-head comparisons available.

What is terminal-browser?

terminal-browser is a real Chromium-based browser that renders inside a terminal emulator, written in TypeScript under the MIT licence, for developers who live in the terminal and for coding agents that need to see and operate the web.

What it is

terminal-browser is a command-line program that draws the pixels of a Chromium browser engine directly into a terminal window. It relies on the kitty graphics protocol, which terminals such as ghostty, kitty, cmux and vscode support, to display pixels produced by Chromium. Pixels are read from the GPU through Electron's offscreen rendering API, which the project states allows rendering without dropped frames. The browser chrome around the page is built with a graphics engine written in Rust, and the interface itself is defined in React through a custom renderer, so the outer UI is authored in TypeScript. Both the browser UI and the page content are drawn to the same shared canvas in the Rust engine, which is what allows interface elements to be layered over the page.

The concrete problem it solves is that a terminal session and a graphical browser are normally separate windows on separate machines, which breaks the loop between an agent working in a terminal and the websites it needs. terminal-browser replaces the separate GUI browser window with a browser running in the same terminal tab as the agent. It listens for mouse clicks, mouse position and keyboard events from the terminal and sends synthetic events to Chromium, reading events that the terminal cannot supply directly from the operating system through a background Swift app. That input path is what enables smooth scrolling and trackpad handling, including sites with infinite canvases.

Key capabilities

  • terminal-browser launches the browser in the current terminal, terminal-browser open opens it at a URL, and terminal-browser --split right opens it in a split pane to the right.
  • terminal-browser open --ssh performs all network requests through a remote server, and terminal-browser ls lists open browsers.
  • terminal-browser action is an agent-browser compatible CLI for interacting with open terminal-browsers, giving an agent programmatic use of the web.
  • terminal-browser upgrade upgrades to the latest version, and installation is available through the curl -fsSL https://terminal-browser.sh/install | bash script or brew install terminal-browser.
  • DevTools open with f12 or ctrl+shift+i, with a dedicated DevTools console, and a command palette is bound to cmd+p on macOS and ctrl+k or alt+k on Linux.
  • Page recording starts and stops with ctrl+r on macOS or ctrl+shift+r on Linux, review completes with ctrl+enter, and ctrl+g starts element selection for sending to an agent.
  • The underlying rendering logic is abstracted into a JavaScript library at https://github.com/zenbu-labs/pixel for building graphical applications in the terminal.

Who uses it and how

  • Developers who keep a coding agent and a website scoped to the same terminal tab, which the README lists as a primary use case.
  • Agent workflows built on the listed claude-code, claude-code-plugin, claude-skills, codex and herdr-plugin topics, where the agent gains the capability to use the web by interacting with open terminal-browsers.
  • Agent-generated HTML plans, which open inside terminal-browser in a split pane next to the agent that produced them.
  • Remote development over SSH, where terminal-browser --ssh lets a developer preview websites running on remote machines without running the browser directly on the remote host.

Getting started

Install with the curl script curl -fsSL https://terminal-browser.sh/install | bash on macOS or Linux, or with brew install terminal-browser. A Claude Code plugin install path is documented at /claude-code-plugin/README.md, and the project homepage is https://terminal-browser.com.

How it compares

No comparable or paid products are named anywhere in the facts supplied for this entry, so terminal-browser stands alone in this registry. The only reference points the project itself gives are the terminals it depends on, namely ghostty, kitty, cmux and vscode as kitty graphics protocol implementations.

When to use it — and when not to

terminal-browser requires a terminal that implements the kitty graphics protocol; on terminals without it, the rendering path does not work at all, so this is not a drop-in browser for every shell. There is no server, database or mail service to operate, since installation is a script or a Homebrew formula and terminal-browser upgrade handles updates, but the project is young in release terms and much of its input behaviour depends on a background Swift app reading operating system events. Anyone needing a fully documented, platform-neutral browser should look elsewhere first, since the README leaves parts of the SSH path and the truncated notes on running the browser directly on a remote machine incomplete.

project readme (upstream, from github) — read inline

terminal-browser

A real browser that runs inside your terminal

Installation

curl (macOS & Linux):

curl -fsSL https://terminal-browser.sh/install | bash

Note: Run terminal-browser upgrade to upgrade versions

Homebrew

brew install terminal-browser

Claude code plugin

Install instructions here

Usage

terminal-browser # launches the browser
terminal-browser open <url> # opens the browser at a url
terminal-browser --split right # opens the browser in a split pane to the right
terminal-browser open --ssh <user@host> <url> # performs all network requests through a remote server
terminal-browser ls # lists open browsers
terminal-browser action # an agent-browser compatible cli for interacting with open terminal-browsers
terminal-browser upgrade # upgrade to the latest version

Use cases:

  • You can have a coding agent and website scoped to the same terminal tab
  • Your agent has full access to interact with open terminal-browsers, which gives your agent the capability to use the web
  • You can ask an agent to make HTML plans and then open them inside terminal-browser, which will automatically open in a split pane next to your agent
  • terminal-browser works over SSH, which allows you to preview websites running on remote machines easily

Shortcuts

Action macOS Linux
Quit ctrl+q or ctrl+c ctrl+q
New tab cmd+t ctrl+t
Edit URL cmd+l ctrl+l
Command palette cmd+p ctrl+k or alt+k
Find in page cmd+shift+f ctrl+shift+f
Next / previous match enter / shift+enter enter / shift+enter
Reload cmd+r ctrl+r
Back / forward cmd+[ / cmd+] or ctrl+[ / ctrl+] ctrl+[ / ctrl+]
Zoom in / out / reset your terminal's zoom keybind your terminal's zoom keybind
Devtools cmd+shift+i or f12 ctrl+shift+i or f12
Devtools console cmd+alt+j ctrl+alt+j
Copy / paste / cut cmd+c / cmd+v / cmd+x ctrl+c / ctrl+v / ctrl+x
Record page (start/stop) ctrl+r ctrl+shift+r
Complete recording review ctrl+enter ctrl+enter
Start element selection (send to agent) ctrl+g ctrl+g
Close popup / overlay escape escape

How does it work?

Terminals that support the kitty graphics protocol, including ghostty, kitty, cmux, vscode and many more, allow a program running in a terminal to display pixels in your terminal. We use this capability to display pixels generated by chromium.

We use electrons offscreen rendering API to read pixels generated by chromium directly from the GPU. This allows terminal-browser to render smoothly without dropping any frames.

After the browser engine starts and is displaying pixels in the terminal, it needs to be able to read user input for websites to actually work. terminal-browser listens to mouse clicks, mouse position, and keyboard events from the terminal, and then sends synthetic events to chromium based on that data. For any user input events that are not retrievable from the terminal, we read directly from the operating system using a background swift app to listen for input events (non intrusively). This is what allows terminal-browser to implement smooth scrolling, and listen to trackpad events (websites with infinite canvases work great inside terminal-browser!)

The outer UI of the browser is implemented using a graphics engine built on top of rust. The actual UI is defined inside react with a custom react renderer, which allows us to build the UI for the browser using typescript. The UI of the outer browser and the browser content itself is all drawn to the same shared canvas inside the rust engine, which allows us to layer UI on top of the browser.

The underlying logic described here has been abstracted into a javascript library that you can use to build your own graphical applications in the terminal - https://github.com/zenbu-labs/pixel

SSH

The recommended way to use terminal-browser over ssh is running terminal-browser --ssh .

The alternative is running terminal-browser directly on the machine you are shh'd into. This will work, but:

  • requires every single frame drawn by the website to be sent over the network
  • all user input must be sent over the network before a website can react
  • misses out some extra optimizations

terminal-browser --ssh improves on this by running the website on your local device, and simply proxying all network requests made by the browser via the remote machine over ssh. This means you can load any website running on localhost of the remote machine on your local device.

Embedded mode

terminal-browser supports embedding inside of existing TUIs. See examples/embedded for a reference implementation

Roadmap

  • linux support ✅
  • chrome extensions
  • design mode

Contributing

  • PR descriptions must be authored by humans and explained well, otherwise we will close them
  • When making a PR, the motivation must be clearly defined in the description
  • Minimize the size of your PR for the best chance to get it landed

To get a local development setup of terminal-browser, the recommended way is to ask a coding agent.

Adding enhanced support for a new terminal

terminal-browser's cli includes sub commands that rely on terminal/multiplexer scripting features. To implement support for a terminal/multiplexer not yet supported, reference existing implementations located here https://github.com/zenbu-labs/terminal-browser/tree/main/terminals/src/terminals

Discord

Acknowledgments

  • the kitty project for developing the kitty graphics protocol
  • awrit - the first attempt to embed chromium inside a terminal

Frequently asked questions

Is terminal-browser free to use?

terminal-browser is open source under the MIT licence. There is no licence fee and no seat count — you can self-host it or, where the project offers one, pay a vendor for a managed version instead.

What does terminal-browser do?

A browser inside your terminal

What is terminal-browser written in?

terminal-browser is primarily written in TypeScript. Its source is publicly available at https://github.com/zenbu-labs/terminal-browser, and it has 3,081 GitHub stars.