Skip to content

Install

  • Linux or macOS, on x86-64 or ARM64
  • Git 2.31 or newer
  • At least one coding agent on your PATH: claude, codex, copilot, opencode, cursor-agent, gemini or agy
  • The GitHub CLI, gh, signed in with gh auth login, for pull requests, CI and issues. Everything else works without it.
Terminal window
curl -fsSL https://nerdr.app/install.sh | sh

The script downloads the latest release for your system from GitHub, checks it against the release’s checksums.txt and puts nerdr in ~/.local/bin. Set NERDR_INSTALL_DIR for another folder, and NERDR_VERSION=v0.1.0 for a release other than the latest:

Terminal window
curl -fsSL https://nerdr.app/install.sh | NERDR_VERSION=v0.1.0 sh

Run it again to update.

Check it:

Terminal window
nerdr version

Start nerdr in the folder that holds your repositories:

Terminal window
cd ~/develop
nerdr

On first start, nerdr asks where new worktrees go (~/worktrees-nerdr by default), where it may install its skills and hooks for the agents, and where it keeps its notes. All of this can be changed later; see Configuration.

  1. With git and Go 1.27 or newer, clone the repository and install the binary:

    Terminal window
    git clone https://github.com/nerdr-dev/nerdr && cd nerdr
    make install # installs to $(go env GOPATH)/bin, usually ~/go/bin
  2. Make sure $(go env GOPATH)/bin is on your PATH, then check with nerdr version.

make all builds the four binaries in dist/ for other machines.

  • nerdr is not signed. The install script, Homebrew and go install are not stopped by Gatekeeper, but an archive downloaded in a browser may be. Remove its quarantine flag with xattr -d com.apple.quarantine nerdr.
  • A Mac laptop may need fn for F1–F5. Use ctrl+q e 1…e 5 instead, or m in the review panel to cycle its screens, and set function_keys = false to show those shortcuts in menus.

Next: Quick start.