---
title: Install
description: Install notes from the AUR or build it locally with mise.
---

## Arch Linux

Install the stable binary package with an AUR helper:

```bash
yay -S repo-notes-bin
```

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

```bash
yay -S repo-notes-git
```

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

## Runtime requirements

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:

| Application   | Used by                                      |
| ------------- | -------------------------------------------- |
| Git           | Repository detection and vault versioning    |
| Bash          | Launching an editor from the interactive TUI |
| Neovim        | Default editor when `EDITOR` is unset        |
| OpenCode      | The TUI's `o` and `O` actions                |
| `notify-send` | Optional MCP write and delete notifications  |
| GitHub CLI    | Queued capture daemon mode                   |

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 processor](/integrations/capture-daemon/) needs a
configured OpenCode CLI in both queued and direct modes.

Stable releases use a semver version shared by the CLI and
`@timmo001/effect-notes`. Create a blank GitHub draft tagged with it,
optionally generate its release notes, then publish it to build Linux
archives, deb and RPM packages, publish the library to npm and JSR, and update
`repo-notes-bin`.

## Build Locally

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

```bash
mise run install
mise run build
```

The compiled binary is written to `dist/notes`:

```bash
./dist/notes --help
```

## Build an Arch Package

Create a local Arch package from the compiled binary:

```bash
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.
