Skip to content

Install

Install the stable binary package with an AUR helper:

Terminal window
yay -S repo-notes-bin

Install repo-notes-git instead to track relevant changes on main:

Terminal window
yay -S repo-notes-git

Both packages install Git, the notes binary, and Bash, Fish, and Zsh completions.

The compiled notes binary includes its JavaScript dependencies and does not need Bun or Node.js at runtime. It uses these external applications for specific features:

ApplicationUsed by
GitRepository detection and vault versioning
BashLaunching an editor from the interactive TUI
NeovimDefault editor when EDITOR is unset
OpenCodeThe TUI’s o and O actions
notify-sendOptional MCP write and delete notifications
GitHub CLIThe optional capture daemon

Git is installed by the Linux packages. Set EDITOR and VISUAL to use other editors instead of Neovim. Missing notify-send only disables desktop notifications. The capture daemon also needs a running OpenCode server.

Stable releases use a manually chosen YYYYMMDD.N version. Create a blank GitHub draft, optionally generate its release notes, then publish it to build Linux archives, deb and RPM packages and update repo-notes-bin.

Use the mise tasks to install dependencies and build the binary. The repo pins Node and Bun through mise.

Terminal window
mise run install
mise run build

The compiled binary is written to dist/notes:

Terminal window
./dist/notes --help

Create a local Arch package from the compiled binary:

Terminal window
mise run package:arch

This task is Arch-specific and needs makepkg from base-devel. The package is written to dist/ and includes shell completions.