Quick Start - Ravi

Prerequisites

Bun >= 1.0
A Claude API key (ANTHROPIC_API_KEY)
NATS server running (downloaded automatically by ravi setup)
omni API running (for channel support — optional for CLI-only usage)

Installation

# Clone the repo
git clone https://github.com/filipexyz/ravi.git
cd ravi

# Install dependencies
bun install

# Run setup wizard (downloads nats-server, configures auth, creates agent)
ravi setup

Configuration

Configure environment in ~/.ravi/.env:

# Required
ANTHROPIC_API_KEY=sk-ant-xxx

# Omni connection (required for WhatsApp/Telegram/Discord)
OMNI_API_URL=http://127.0.0.1:8882
OMNI_API_KEY=your-omni-api-key

# NATS (default: nats://127.0.0.1:4222)
NATS_URL=nats://127.0.0.1:4222

See Configuration for all environment variables.

Start the Daemon

# Start the daemon (managed by PM2)
ravi daemon start

# Check status
ravi daemon status

# View logs
ravi daemon logs -f

Connect WhatsApp

# Create and connect an instance
ravi instances connect main

Scan the QR code with WhatsApp on your phone.

Test Your Agent

# Send a prompt to an agent session
ravi sessions send agent:main:main "oi, tudo bem?"

# Interactive TUI
ravi tui