Quickstart

1. Install Omni

   Run the install script or use the interactive wizard:

   1curl -fsSL https://raw.githubusercontent.com/automagik-dev/omni/main/install.sh | bash

   Or if you already have the repo:

   1omni install

   Verify the installation:

   1omni status

2. Connect a Channel

   Create a WhatsApp instance and pair it:

   12345678# 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:

   1omni instances status <instance-id>

3. Send Your First Message

   12345678# 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

   1234567891011# 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:

   123456789101112# 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