Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.automagik.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
Quickstart

Connect a channel and send your first message in under 5 minutes.
1

Install Omni

Run the install script or use the interactive wizard:
curl -fsSL https://raw.githubusercontent.com/automagik-dev/omni/main/install.sh | bash
Or if you already have the repo:
omni install
Verify the installation:
omni status
2

Connect a Channel

Create a WhatsApp instance and pair it:
# Create the instance
omni instances create --channel whatsapp-baileys --name "My WhatsApp"

# Get the QR code — scan with WhatsApp on your phone
omni instances qr <instance-id>

# Or use a pairing code instead
omni instances pair <instance-id> --phone +5511999999999
Check the connection:
omni instances status <instance-id>
3

Send Your First Message

# Send a text message
omni send --to +5511999999999 --text "Hello from Omni!"

# Send an image with caption
omni send --to +5511999999999 --media ./photo.jpg --caption "Check this out"

# Send a voice note via TTS
omni send --to +5511999999999 --tts "Hello, this is a voice message!"
4

Explore Your Messages

# List recent chats
omni chats list

# Read messages in a chat
omni chats messages <chat-id>

# Search across all messages
omni messages search "hello"

# Check recent events
omni events list --limit 10
5

Connect an AI Agent (Optional)

Route incoming messages to an AI agent:
# Create an agent provider (e.g. an Agno backend)
omni providers create --name "Agno" --schema agno --base-url https://agno.example.com --api-key <key>

# Create an agent bound to that provider
omni agents create \
  --name "My Agent" \
  --provider agno \
  --agent-provider <agent-provider-id> \
  --provider-agent-id support-bot

# Route all messages from this instance to the agent
omni routes create --instance <instance-id> --agent <agent-id>

​
What’s Next

Instances

Learn about channel connections, lifecycle, and sync.

Agent Routing

Configure AI agents and routing rules.

Automations

Set up event-driven automations.

CLI Reference

Full command reference.