Chawan is a TUI web (and (S)FTP, Gopher, Gemini, ...) browser with CSS, inline image and JavaScript support.
It uses its own minimal browser engine developed from scratch, which can display many websites in a manner similar to major graphical browsers.
It can also be used as a terminal pager.
A Unix-like operating system (Linux, *BSD, Haiku, macOS, ...) is assumed. On Windows you have to use WSL.
git clone https://git.sr.ht/~bptato/chawan && cd chawan
nim -v
displays
your Nim compiler's version.)export CFLAGS=-fpermissive
.make
(without arguments).make install
(e.g. sudo make install
).Then, try:
$ cha -V # open in visual mode for a list of default keybindings
$ cha example.org # open your favorite website directly from the shell
$ mancha cha # read the cha(1) man page using `mancha'
You can also install Chawan from packages maintained by volunteers:
Currently implemented features are:
cha file.md
), man page viewer (mancha
)...with a lot more planned.
First, read the troubleshooting document. If it doesn't help, open a ticket.
When using the ticket tracker, please make sure your tickets are valid markdown, or they become unreadable on the web interface.
If you want to send plain text e-mails not formatted as markdown, use the mailing list instead. This is also where you can send patches.
Chawan's documentation is available as man pages (man cha
) and as
Markdown files.
If you're interested in modifying the code:
w3m has been the main inspiration for Chawan; although the two do not share code, the UI and feature set is similar.
Ferus is a separate graphical browser engine written in Nim, which uses Chawan's HTML parser.
Chawan is dedicated to the public domain. See the UNLICENSE file for details.
Chawan also includes and depends on several permissively licensed libraries. For further details, check the about:license page in Chawan, or read the same document here.