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

Install

curl -fsS https://chase.github.io/awrit/get | bash

By default, this will download to ~/awrit and link to ~/.local/bin/awrit.

You can configure awrit by changing ~/awrit/config.js. See Configuration for more information.

(Optional) Change Download Location or Install Prefix

curl -fsS https://chase.github.io/awrit/get | DOWNLOAD_TO=~/somewhere-completely-different bash

curl -fsS https://chase.github.io/awrit/get | INSTALL_TO=~/.not-local bash

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.

Contributing

See Contributing to Awrit.

Development

Assuming you already have git installed, your installation of awrit will already be a Git repository.

You can update awrit to use your fork by changing the origin:

# note: you'll have to change the username some-kind-contributor to your GitHub username
git remote set-url origin git@github.com:some-kind-contributor/awrit.git
# also track the upstream electron branch
git remote add upstream -f -t electron git@github.com:chase/awrit.git

You can make a branch (ex: my-feature-branch) off the latest changes by doing:

git fetch upstream electron
git checkout upstream/electron
git switch -c 'my-feature-branch'

Read Your First Code Contribution for more information on making a PR.