Reeve
Getting Started

CLI Setup

Install the Reeve CLI, run the onboarding wizard, and configure your gateway.

CLI Setup

The Reeve CLI gives you full control over your gateway, agents, channels, and configuration from the terminal.

Installation

curl -fsSL https://meetreeve.com/install.sh | bash

This downloads the latest release, installs it to ~/.reeve/bin/, and adds it to your PATH.

Requirements: Node.js 22 or later.

Reeve runs on Windows via WSL2. Install WSL2 first, then run the Linux installer inside it:

# In WSL2 (Ubuntu recommended)
curl -fsSL https://meetreeve.com/install.sh | bash

See Windows setup for detailed WSL2 instructions.

npm install -g reeve@latest

Or with pnpm:

pnpm add -g reeve@latest

This works on any platform with Node.js 22+.

Verify the installation:

reeve --version

Onboarding Wizard

The fastest way to configure everything:

reeve onboard --install-daemon

The wizard guides you through:

  1. Gateway mode — Local or remote
  2. LLM authentication — API keys (recommended) or OAuth
  3. Chat channels — WhatsApp QR, Telegram bot token, Discord bot token
  4. Background service — Install as launchd (macOS) or systemd (Linux) service
  5. Gateway token — Generated automatically for API security

The --install-daemon flag sets up the gateway as a background service that starts automatically on boot. You can skip this and run manually with reeve gateway.

Manual Configuration

If you prefer to configure manually instead of using the wizard:

Set up LLM providers

reeve configure --section auth

Or add keys directly to your config:

{
  "models": {
    "providers": {
      "anthropic": { "apiKey": "sk-ant-..." },
      "openai": { "apiKey": "sk-..." }
    }
  }
}
reeve configure --section web

This sets up a Brave Search API key for the web_search tool. Highly recommended — it gives your agents access to current information.

Start the gateway

Foreground (for debugging):

reeve gateway --port 18789 --verbose

Background (as a service):

reeve gateway install
reeve gateway start

Verify

reeve status        # Gateway status
reeve health        # Full health check
reeve doctor        # Diagnose common issues

Configuration File

All CLI configuration lives in reeve.json:

macOS:   ~/Library/Application Support/Reeve/reeve.json
Linux:   ~/.config/reeve/reeve.json
Fallback: ~/.reeve/reeve.json

The file is created automatically during onboarding. See Configuration for the full reference.

Key Commands

CommandWhat it does
reeve statusShow gateway status and connected channels
reeve healthRun health checks on all subsystems
reeve doctorDiagnose and fix common issues
reeve agents listList configured agents
reeve agents addAdd a new agent (interactive)
reeve channels loginConnect a chat channel (WhatsApp QR, etc.)
reeve gatewayStart the gateway in foreground
reeve configureInteractive configuration editor

See the full CLI reference for all commands.

Next Steps

On this page