Skip to content
/ awrit Public

A full graphical web browser for Kitty terminal with mouse and keyboard support

License

Notifications You must be signed in to change notification settings

chase/awrit

Actual Web Rendering in Terminal

Or just awrit.

awrit-demo.webm

Yep, actual Chromium being rendered in your favorite terminal that supports the Kitty terminal graphics protocol.

awrit works best in Kitty v0.31 or newer

Why?

  • Display documentation from DevDocs
  • Watch the changes from Vite come to life
  • Tiled layout without a tiling window manager using Kitty's layouts
  • Add fancy UI using web technologies, so NeoVim can pretend it is Emacs instead of the other way around

Running

git clone https://github.com/chase/awrit.git
cd awrit
./awrit

(Optional) Install

The following installs a link to awrit in ~/.local/bin:

PREFIX=~/.local/bin
DIR="$PWD"
(cd "$PREFIX" && ln -s "$DIR/awrit")

Usage

./awrit [url]

# if url is not provided, it will go to the awrit homepage (this is temporary, promise)
# the URL protocol can be http:, https:, or data:
# if the URL protocol is not included, https: is used by default

For more options look at the help:

./awrit --help

Configuration

awrit can be configured through config.js in the project root. Changes to it will update the config in any running awrit.

Currently it only supports custom keybindings and changing the homepage that displays when no URL is provided.

For more details on keybinding syntax and available actions, see the comments in config.js.

About

A full graphical web browser for Kitty terminal with mouse and keyboard support

Resources

License

Code of conduct

Stars

Watchers

Forks

Contributors 3

  •  
  •  
  •