> ## 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
> From zero to your first message in 5 minutes — install, connect, send.
# Quickstart
Connect a channel and send your first message in under 5 minutes.
Run the install script or use the interactive wizard:
```bash theme={"dark"}
curl -fsSL https://raw.githubusercontent.com/automagik-dev/omni/main/install.sh | bash
```
Or if you already have the repo:
```bash theme={"dark"}
omni install
```
Verify the installation:
```bash theme={"dark"}
omni status
```
Create a WhatsApp instance and pair it:
```bash theme={"dark"}
# 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
# Or use a pairing code instead
omni instances pair --phone +5511999999999
```
Check the connection:
```bash theme={"dark"}
omni instances status
```
```bash theme={"dark"}
# 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!"
```
```bash theme={"dark"}
# List recent chats
omni chats list
# Read messages in a chat
omni chats messages
# Search across all messages
omni messages search "hello"
# Check recent events
omni events list --limit 10
```
Route incoming messages to an AI agent:
```bash theme={"dark"}
# Create an agent provider (e.g. an Agno backend)
omni providers create --name "Agno" --schema agno --base-url https://agno.example.com --api-key
# Create an agent bound to that provider
omni agents create \
--name "My Agent" \
--provider agno \
--agent-provider \
--provider-agent-id support-bot
# Route all messages from this instance to the agent
omni routes create --instance --agent
```
## What's Next
Learn about channel connections, lifecycle, and sync.
Configure AI agents and routing rules.
Set up event-driven automations.
Full command reference.