Skip to main content

​
System Commands

Commands for configuration, event querying, batch processing, prompt management, and diagnostics.

​
omni config

Manage CLI configuration — default instance, output format, API settings. 
omni config list            # List all config values
omni config get <key>       # Get a value
omni config set <key> <val> # Set a value
omni config unset <key>     # Remove a value
Common settings: 
omni config set instance <id>     # Set default instance
omni config set format json       # Default to JSON output

​
omni events

Query the event log — message history, analytics, and replay. 
omni events list                              # List recent events
omni events list --instance <id> --limit 50   # Filter by instance
omni events search <query>                    # Search events by content

​
Analytics

omni events metrics              # Processing metrics
omni events analytics            # Event analytics summary
omni events timeline <person-id> # Event timeline for a person

​
Replay

omni events replay               # Start, list, or manage replay sessions

​
omni batch

Batch processing for media transcription and text extraction at scale. 
omni batch list                         # List batch jobs
omni batch create [options]             # Create a processing job
omni batch status <job-id>              # Check job status
omni batch cancel <job-id>              # Cancel a running job
omni batch estimate [options]           # Estimate scope and cost

​
omni prompts

Manage LLM prompt overrides for media processing. Omni uses prompts for image description, video description, document extraction, and gating decisions. 
omni prompts list                       # List all prompts with override status
omni prompts get <name>                 # Show current prompt (image|video|document|gate)
omni prompts set <name> [value]         # Set override (reads stdin for multiline)
omni prompts reset <name>               # Clear override, revert to default

​
omni journey

Message journey tracing — track a message through the full Omni pipeline for latency debugging. 
omni journey show <correlation-id>      # Display journey timeline with timing bars
omni journey summary                    # Aggregated journey metrics

​
omni replay

Replay missed messages for an agent instance. Useful for recovering messages that arrived while an agent was offline. 
omni replay <instanceId> [options]
OptionDescription
-s, --since <timestamp>Replay messages received after this ISO 8601 timestamp (default: lastSeenAt, max 24h ago)
# Replay missed messages since the agent's last seen time
omni replay wa-main

# Replay messages received after a specific timestamp
omni replay wa-main --since 2026-02-27T10:00:00Z

​
omni auth

Manage API authentication — login, check status, logout, and recover credentials. 
omni auth [command]

​
Subcommands

CommandDescription
loginSave API credentials
statusShow current authentication status
logoutClear stored credentials
recoverRecover API key when keyValid shows no (requires local PM2 access)
# Save credentials
omni auth login

# Check current auth status
omni auth status

# Clear stored credentials
omni auth logout

# Recover a broken API key
omni auth recover

​
omni settings

Server-level settings. 
omni settings                           # View server settings

​
Service Management

Start, stop, and restart the Omni server and NATS: 
omni start      # Start Omni services (API + NATS)
omni stop       # Stop services
omni restart    # Restart services
omni status     # API health and connection info
omni update     # Update CLI to latest version

​
omni logs

View system logs. This is a hidden debug command (visible with --all). 
omni logs [options] [level]
ArgumentDescription
levelLog level filter: debug, info, warn, error
OptionDescription
--modules <modules>Comma-separated module names to filter
--limit <n>Limit results (default: 100)
--process [service]Stream PM2 process logs (default: api)
--followStream live logs (only with --process)
omni logs error --limit 50
omni logs --process api --follow
omni logs warn --modules webhook,agent

​
omni completions

Generate shell completions for the Omni CLI. 
omni completions [shell]
ArgumentDescription
shellShell type: bash, zsh, fish
omni completions bash >> ~/.bashrc
omni completions zsh >> ~/.zshrc

​
Global Flags

These flags work with any command:
FlagDescription
--jsonOutput in JSON format
--no-colorDisable colored output