Installation

yomi is a single binary. Pick whichever channel suits you.

Go

go install github.com/tamnd/yomi/cmd/yomi@latest

Homebrew

brew install tamnd/tap/yomi

Scoop

scoop bucket add tamnd https://github.com/tamnd/scoop-bucket
scoop install yomi

Release archives and Linux packages

Every release attaches tar.gz archives (and a .zip for Windows) for Linux, macOS, Windows, and FreeBSD, plus .deb, .rpm, and .apk packages. Download the one for your platform, extract yomi, and put it on your PATH.

# Debian/Ubuntu
sudo dpkg -i yomi_*_linux_amd64.deb

# Fedora/RHEL
sudo rpm -i yomi_*_linux_amd64.rpm

Container

The image bundles Chromium and sets CHROME_BIN, so the render path works out of the box:

docker run -v "$PWD:/out" ghcr.io/tamnd/yomi read example.com -o /out/page.md

When you need a browser

yomi fetches a static page with a plain HTTP request, no browser involved. It launches headless Chrome only on the render path: when --render auto decides a page is JavaScript-gated, or when you pass --render on. In auto mode many pages never start a browser at all, so for a lot of reads you need nothing extra.

When yomi does render, it needs Chrome or Chromium on the machine. It looks for a system install automatically (Google Chrome on macOS and Windows, google-chrome/chromium on Linux). To point it at a specific binary:

yomi read example.com --chrome /path/to/chromium
# or
export CHROME_BIN=/path/to/chromium

The container image sets CHROME_BIN to its bundled Chromium for you. If you only ever read static pages, you can run with --render off and never touch a browser.

Next: the quick start.