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 | bashThis 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 | bashSee Windows setup for detailed WSL2 instructions.
npm install -g reeve@latestOr with pnpm:
pnpm add -g reeve@latestThis works on any platform with Node.js 22+.
Verify the installation:
reeve --versionOnboarding Wizard
The fastest way to configure everything:
reeve onboard --install-daemonThe wizard guides you through:
- Gateway mode — Local or remote
- LLM authentication — API keys (recommended) or OAuth
- Chat channels — WhatsApp QR, Telegram bot token, Discord bot token
- Background service — Install as launchd (macOS) or systemd (Linux) service
- 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 authOr add keys directly to your config:
{
"models": {
"providers": {
"anthropic": { "apiKey": "sk-ant-..." },
"openai": { "apiKey": "sk-..." }
}
}
}Configure web search
reeve configure --section webThis 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 --verboseBackground (as a service):
reeve gateway install
reeve gateway startVerify
reeve status # Gateway status
reeve health # Full health check
reeve doctor # Diagnose common issuesConfiguration File
All CLI configuration lives in reeve.json:
macOS: ~/Library/Application Support/Reeve/reeve.json
Linux: ~/.config/reeve/reeve.json
Fallback: ~/.reeve/reeve.jsonThe file is created automatically during onboarding. See Configuration for the full reference.
Key Commands
| Command | What it does |
|---|---|
reeve status | Show gateway status and connected channels |
reeve health | Run health checks on all subsystems |
reeve doctor | Diagnose and fix common issues |
reeve agents list | List configured agents |
reeve agents add | Add a new agent (interactive) |
reeve channels login | Connect a chat channel (WhatsApp QR, etc.) |
reeve gateway | Start the gateway in foreground |
reeve configure | Interactive configuration editor |
See the full CLI reference for all commands.
Next Steps
- Core Concepts — Understand agents, sessions, and memory
- Connect chat channels — WhatsApp, Telegram, Discord, Slack
- Desktop App — If you prefer a GUI over the CLI