Installation

Belay installs as a global npm package. One command, no signup required.

Requirements

Node 20 or later. Belay checks this automatically during setup and reports if your version is too old.
npm (or any npm-compatible package manager).
An AI coding agent you already use: Claude Code, Cursor, VS Code Copilot, or Codex.

Install

bash

$ npm install -g @oz-lunara/belay

This installs the belay command-line tool globally. You will use it from inside your project directories.

Verify the installation

Run the health check to confirm Belay is installed and your environment is ready:

bash

$ belay doctor

belay doctor runs every onboarding check and prints a [ok] / [warn] / [fail] result for each one, along with the fix for anything that needs attention. It exits non-zero if any check fails.

You can also print the installed version:

bash

$ belay --version

Updating Belay

To update to the latest release, stop the daemon, install the new version, then re-run setup to pick up any new protections:

bash

$ belay daemon stop
$ npm install -g @oz-lunara/belay@latest
$ belay setup

Re-running belay setup after an upgrade is safe. It merges into your existing configuration without overwriting anything.

← Previous

Introduction

Setup