Skip to content

Getting Started

This guide will help you get OmniAgent up and running quickly.

Installation

From Source

go install github.com/plexusone/omniagent/cmd/omniagent@latest

Verify Installation

omniagent version

Quick Start with WhatsApp

The fastest way to get started is with WhatsApp and OpenAI:

# Set your OpenAI API key
export OPENAI_API_KEY="sk-..."

# Run with WhatsApp enabled
OMNIAGENT_AGENT_PROVIDER=openai \
OMNIAGENT_AGENT_MODEL=gpt-4o \
WHATSAPP_ENABLED=true \
omniagent gateway run

A QR code will appear in your terminal. Scan it with WhatsApp (Settings → Linked Devices → Link a Device) to connect.

Configuration File

For more control, create a configuration file:

# omniagent.yaml
gateway:
  address: "127.0.0.1:18789"

agent:
  provider: openai          # or: anthropic, gemini
  model: gpt-4o             # or: claude-sonnet-4-20250514, gemini-2.0-flash
  api_key: ${OPENAI_API_KEY}
  system_prompt: "You are OmniAgent, responding on behalf of the user."

channels:
  whatsapp:
    enabled: true
    db_path: "whatsapp.db"  # Session storage

  telegram:
    enabled: false
    token: ${TELEGRAM_BOT_TOKEN}

  discord:
    enabled: false
    token: ${DISCORD_BOT_TOKEN}

voice:
  enabled: true
  response_mode: auto        # auto, always, never
  stt:
    provider: deepgram
    model: nova-2
  tts:
    provider: deepgram
    model: aura-asteria-en
    voice_id: aura-asteria-en

skills:
  enabled: true
  paths:                     # Additional skill directories
    - ~/.omniagent/skills
  max_injected: 20           # Max skills to inject into prompt

Run with the config file:

omniagent gateway run --config omniagent.yaml

Using Different LLM Providers

Anthropic (Claude)

export ANTHROPIC_API_KEY="sk-ant-..."

OMNIAGENT_AGENT_PROVIDER=anthropic \
OMNIAGENT_AGENT_MODEL=claude-sonnet-4-20250514 \
WHATSAPP_ENABLED=true \
omniagent gateway run

Google Gemini

export GEMINI_API_KEY="..."

OMNIAGENT_AGENT_PROVIDER=gemini \
OMNIAGENT_AGENT_MODEL=gemini-2.0-flash \
WHATSAPP_ENABLED=true \
omniagent gateway run

Next Steps