Skip to content
brothydocs
Install

Install

Download the brothy binary for macOS or Linux, or build it from source with Bun.

Requirements: macOS or Linux (Windows is not supported) and a terminal with true color and Unicode.

Download brothy-<os>-<arch> for your platform (linux or darwin, x64 or arm64) and SHA256SUMS from the releases page, then:

sha256sum -c --ignore-missing SHA256SUMS # shasum -a 256 -c on macOS
chmod +x brothy-linux-x64
mv brothy-linux-x64 ~/.local/bin/brothy # any folder on your PATH

Or fetch it straight from the latest release (pick your platform):

curl -fLo brothy https://github.com/jackMort/brothy/releases/latest/download/brothy-linux-x64
chmod +x brothy && mv brothy ~/.local/bin/brothy

Needs Bun 1.4 or newer:

git clone https://github.com/jackMort/brothy.git && cd brothy
bun install
bun run build # single binary ./brothy, parsers embedded

brothy is not published to npm; releases ship prebuilt binaries only.

brothy --version
brothy ~/notes

The logo in the top line is a Nerd Font glyph, so it shows as a box in a terminal font without one. Nothing else depends on it.

Keys any key closes

jk
scroll
gG
top · bottom
[]
previous · next section
/
search the docs
123
Files · Outline · Info
ctrl+b
hide / show the panel
t
theme picker
space
play / pause the tour (front page)
esc
close the drawer
?
this sheet

brothy's own keys: keyboard reference