Skip to main content

Omnara Agent Dashboard - MCP Server and Python SDK

Project description

Omnara - Mission Control for Your AI Agents 🚀

Your AI workforce, in your pocket.

PyPI version Downloads Python Versions License GitHub stars Ruff

Omnara Mobile Experience


🚀 Quick Start

# Install Omnara (requires python >= 3.10)
pip install omnara

# Start a Claude Code session that's synced between terminal, web, and mobile
omnara

# Start a Codex CLI session that's synced between terminal, web, and mobile
omnara --agent codex

That's it! Create an account when prompted, then return to your terminal to interact with your coding agent. You can now see and interact with your coding agent session from the web dashboard or the mobile app.

💡 What is Omnara?

Omnara transforms your AI agents (Claude Code, Codex CLI, n8n, and more) from silent workers into communicative teammates. Get real-time visibility into what your agents are doing, and respond to their questions instantly from a single dashboard on web and mobile.

🎬 See It In Action

Agent Activity Feed

📖 How to Use

1. Omnara CLI

The primary way to use CLI coding agents (Claude Code, Codex CLI) with Omnara

Installation

Install Omnara using your preferred package manager:

# Using pip
pip install omnara

# Using uv
uv tool install omnara

# Using pipx
pipx install omnara

Running Omnara

Omnara offers three different modes depending on your workflow:

Standard Mode - Full Claude Code/Codex CLI Experience
omnara

Starts Claude Code with the standard CLI interface, fully synced across terminal, web dashboard, and mobile app. You interact with Claude Code in your terminal as usual, while everything is mirrored to the Omnara dashboard.

omnara --agent codex

Starts Codex with the standard CLI interface with the same features as noted above

Headless Mode - Dashboard-Only Interaction
omnara headless

Runs Claude Code in the background without the terminal UI. Perfect for when you want to interact with Claude Code exclusively through the Omnara web dashboard or mobile app.

Server Mode - Remote Launch Capability
omnara serve

Exposes an endpoint that allows you to launch Claude Code instances remotely from the Omnara dashboard. Ideal for triggering AI agents from your phone or another device.

Upgrading

Keep Omnara up-to-date with the latest features:

# Using pip
pip install omnara --upgrade

# Using uv
uv tool upgrade omnara

# Using pipx
pipx upgrade omnara

2. n8n Integration

Add human-in-the-loop capabilities to your n8n workflows

What it Does

The Omnara n8n integration provides a specialized "Human in the Loop" node that enables real-time human-AI collaboration within your n8n workflows. Perfect for approval workflows, agent conversations, and guided automation.

Installation & Setup

For detailed installation and configuration instructions, see the n8n-nodes-omnara package on npm.

3. GitHub Actions Integration

Run Claude Code in GitHub Actions with Omnara monitoring

What it Does

The Omnara GitHub Actions integration allows you to trigger Claude Code to run in your GitHub Actions workflows via repository dispatch events, while monitoring and interacting with it through the Omnara dashboard.

Key Features

  • Remote Launch: Start GitHub Actions from your phone or web dashboard
  • Automatic PR Creation: Claude creates branches, commits changes, and opens PRs
  • Real-time Monitoring: Track progress and provide guidance through Omnara

Installation & Setup

For complete setup instructions including GitHub workflow configuration, see the GitHub Actions integration guide.

🔧 Integrating your own Agent into Omnara

Method 1: Manual MCP Configuration

For custom MCP setups, you can configure manually:

{
  "mcpServers": {
    "omnara": {
      "command": "pipx",
      "args": ["run", "--no-cache", "omnara", "mcp", "--api-key", "YOUR_API_KEY"]
    }
  }
}

Method 2: Python SDK

from omnara import OmnaraClient
import uuid

client = OmnaraClient(api_key="your-api-key")
instance_id = str(uuid.uuid4())

# Log progress and check for user feedback
response = client.send_message(
    agent_type="claude-code",
    content="Analyzing codebase structure",
    agent_instance_id=instance_id,
    requires_user_input=False
)

# Ask for user input when needed
answer = client.send_message(
    content="Should I refactor this legacy module?",
    agent_instance_id=instance_id,
    requires_user_input=True
)

Method 3: REST API

curl -X POST https://agent.omnara.com/api/v1/messages/agent \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"content": "Starting deployment process", "agent_type": "claude-code", "requires_user_input": false}'

🏗️ Architecture Overview

Omnara provides a unified platform for monitoring and controlling your AI agents:

graph TB
    subgraph "Your AI Agents"
        A[🤖 AI Agents<br/>Claude Code, Cursor, etc.]
    end

    subgraph "Omnara Platform"
        API[🌐 API Server]
        DB[(📊 PostgreSQL)]
        NOTIFY[🔔 Notification Service<br/>Push/Email/SMS]
    end

    subgraph "Your Devices"
        M[📱 Mobile App]
        W[💻 Web Dashboard]
    end

    A -->|Send updates| API
    API -->|Store data| DB
    API -->|Trigger notifications| NOTIFY
    NOTIFY -->|Alert users| M
    DB -->|Real-time sync| M
    DB -->|Real-time sync| W
    M -->|User responses| API
    W -->|User responses| API
    API -->|Deliver feedback| A

    style A fill:#e3f2fd,stroke:#1976d2,stroke-width:3px,color:#000
    style API fill:#c8e6c9,stroke:#388e3c,stroke-width:2px,color:#000
    style DB fill:#ffccbc,stroke:#d84315,stroke-width:2px,color:#000
    style NOTIFY fill:#fff59d,stroke:#f57f17,stroke-width:2px,color:#000
    style M fill:#f8bbd0,stroke:#c2185b,stroke-width:3px,color:#000
    style W fill:#f8bbd0,stroke:#c2185b,stroke-width:3px,color:#000

For Developers

🛠️ Development Setup

Prerequisites: Docker, Python 3.10+, Node.js

Quick Start:

git clone https://github.com/omnara-ai/omnara
cd omnara
cp .env.example .env
python infrastructure/scripts/generate_jwt_keys.py
./dev-start.sh  # Starts everything automatically

Stop services: ./dev-stop.sh

For detailed setup instructions, manual configuration, and contribution guidelines, see our Contributing Guide.

🤝 Contributing

We love contributions! Check out our Contributing Guide to get started.

Development Commands

make lint       # Run code quality checks
make format     # Auto-format code
make test       # Run test suite
./dev-start.sh  # Start development servers

📊 Pricing

Plan Price Features
Free $0/mo 10 agents/month, Core features
Pro $9/mo Unlimited agents, Priority support
Enterprise Contact Us Teams, SSO, Custom integrations

🆘 Support

📜 License

Omnara is open source software licensed under the Apache 2.0 License.


Built with ❤️ by the Omnara team

WebsiteTwitterLinkedIn

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

omnara-1.6.21.tar.gz (122.7 kB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

omnara-1.6.21-cp313-cp313-manylinux_2_28_x86_64.whl (10.6 MB view details)

Uploaded CPython 3.13manylinux: glibc 2.28+ x86-64

omnara-1.6.21-cp313-cp313-macosx_11_0_arm64.whl (8.1 MB view details)

Uploaded CPython 3.13macOS 11.0+ ARM64

omnara-1.6.21-cp313-cp313-macosx_10_13_x86_64.whl (8.7 MB view details)

Uploaded CPython 3.13macOS 10.13+ x86-64

omnara-1.6.21-cp312-cp312-manylinux_2_28_x86_64.whl (10.6 MB view details)

Uploaded CPython 3.12manylinux: glibc 2.28+ x86-64

omnara-1.6.21-cp312-cp312-macosx_11_0_arm64.whl (8.1 MB view details)

Uploaded CPython 3.12macOS 11.0+ ARM64

omnara-1.6.21-cp312-cp312-macosx_10_13_x86_64.whl (8.7 MB view details)

Uploaded CPython 3.12macOS 10.13+ x86-64

omnara-1.6.21-cp311-cp311-manylinux_2_28_x86_64.whl (10.6 MB view details)

Uploaded CPython 3.11manylinux: glibc 2.28+ x86-64

omnara-1.6.21-cp311-cp311-macosx_11_0_arm64.whl (8.1 MB view details)

Uploaded CPython 3.11macOS 11.0+ ARM64

omnara-1.6.21-cp311-cp311-macosx_10_12_x86_64.whl (8.7 MB view details)

Uploaded CPython 3.11macOS 10.12+ x86-64

omnara-1.6.21-cp310-cp310-manylinux_2_28_x86_64.whl (10.6 MB view details)

Uploaded CPython 3.10manylinux: glibc 2.28+ x86-64

omnara-1.6.21-cp310-cp310-macosx_11_0_arm64.whl (8.1 MB view details)

Uploaded CPython 3.10macOS 11.0+ ARM64

omnara-1.6.21-cp310-cp310-macosx_10_12_x86_64.whl (8.7 MB view details)

Uploaded CPython 3.10macOS 10.12+ x86-64

File details

Details for the file omnara-1.6.21.tar.gz.

File metadata

  • Download URL: omnara-1.6.21.tar.gz
  • Upload date:
  • Size: 122.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.11

File hashes

Hashes for omnara-1.6.21.tar.gz
Algorithm Hash digest
SHA256 21959b1b905fb64e43a42040127eddec89671097d132df8afe695376a773264f
MD5 41925e55ed587fd5757ae6bf9a1cae9b
BLAKE2b-256 1e0bbcc08499ffa4584899eff34805f5ecb9b444e96a177fc29c61af9e68e89f

See more details on using hashes here.

File details

Details for the file omnara-1.6.21-cp313-cp313-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for omnara-1.6.21-cp313-cp313-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 8f6facff3e3ae44ed30a6d2df7e0ba811be274b1a0f736afe52b33e3df9cb93f
MD5 ad4aac1714568604b4b51a4b20142910
BLAKE2b-256 6564e23338e4805c4af39494531b48019171fc9b3e201d46b267c3f02242f077

See more details on using hashes here.

File details

Details for the file omnara-1.6.21-cp313-cp313-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for omnara-1.6.21-cp313-cp313-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 9202db87e6a0718528176b709cb858e5d341a6381180447f83cefe654b7399b3
MD5 70ea64bd6ac2bffb1ca2e5b7b47c1c87
BLAKE2b-256 2ced4fcfd5d1ace68f58747315f037cd6fd27c04799b2259f2ef972edc89daff

See more details on using hashes here.

File details

Details for the file omnara-1.6.21-cp313-cp313-macosx_10_13_x86_64.whl.

File metadata

File hashes

Hashes for omnara-1.6.21-cp313-cp313-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 67eec7428bb1108ac8f238a61c0b067a1157c7d32eabc4a437adf36dbb88263c
MD5 fcb83be42578d030d6efe03141e17a61
BLAKE2b-256 066a5a35135050e6a1d66c5c9a1d4c0dee82980fc81683f8f20fcee11f68ca80

See more details on using hashes here.

File details

Details for the file omnara-1.6.21-cp312-cp312-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for omnara-1.6.21-cp312-cp312-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 d6adfa088393acd788d534663b4f0616bc6727341aa078d853f3059a5d5a5d6b
MD5 0c81609608238ad4cb72071ba3e8b310
BLAKE2b-256 309ddeabd1c8c0780fde468bdcfd2f5db8659cb18a50a74f93db9d8c5714d19e

See more details on using hashes here.

File details

Details for the file omnara-1.6.21-cp312-cp312-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for omnara-1.6.21-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 fdc340a6f0ec6c89cd4ce065346bb9aed2458410133968361c84c83b21863676
MD5 e9ea6d8ef9fd302bd019f937be0bd187
BLAKE2b-256 743bdec787b255b0bec248839953030254d850340f5e844378f957cc0cf3f8c1

See more details on using hashes here.

File details

Details for the file omnara-1.6.21-cp312-cp312-macosx_10_13_x86_64.whl.

File metadata

File hashes

Hashes for omnara-1.6.21-cp312-cp312-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 c3b7e692a4914a5226219901f0dae9b35e397a65d1006f1a2e3bcac6c1f6fb22
MD5 163dc0b1763efdd4cad288c2ca450a59
BLAKE2b-256 5abbb6bf449aad65deb1925dcc1934123d669717915f46480bddce5d952bafdc

See more details on using hashes here.

File details

Details for the file omnara-1.6.21-cp311-cp311-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for omnara-1.6.21-cp311-cp311-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 a339163ce2d2dfbc7cdb15bf90d0a3ee5578cb581bc851eca602efe9145d8329
MD5 f4e8c06555325c661741dfb44e81dfb0
BLAKE2b-256 e436d27cd3b6f7ae679b731c498b568c3705c5198a32ae6b2c73e43c19210989

See more details on using hashes here.

File details

Details for the file omnara-1.6.21-cp311-cp311-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for omnara-1.6.21-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 5351ec0130fdf5b105a3437292eb8d7c56c4e11d4e293793d9664b9b55f413aa
MD5 308258e0a46722c89a21648bdb6d3440
BLAKE2b-256 729ea9782d3175d40269875ec185568b9fad5b3d867a99c090568c0b5df19a91

See more details on using hashes here.

File details

Details for the file omnara-1.6.21-cp311-cp311-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for omnara-1.6.21-cp311-cp311-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 f12eaeda6d569dbbd81c4bd8687b0068b22e305892f91b4a03d6d25e3efeee0b
MD5 2da8d2ee89002c5e0a3ec4839ccf4b16
BLAKE2b-256 757c15f4a8fbb2b3faec46ecea5f3a17645dfd58f63898600dbae33a080ca747

See more details on using hashes here.

File details

Details for the file omnara-1.6.21-cp310-cp310-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for omnara-1.6.21-cp310-cp310-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 2fcc45c5d04c4db5277e7c52cc3f949848a7604ee3070dba997b4f71f8335485
MD5 12fae9bacbc7ccce617cd58d63a5f637
BLAKE2b-256 aadc1cdc8c30ce10285c14dae5def76a09bd180fb4dd77188b3b4f083258209a

See more details on using hashes here.

File details

Details for the file omnara-1.6.21-cp310-cp310-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for omnara-1.6.21-cp310-cp310-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 cdc4366b8e94bf4c37456cadd1de48f6e0f4a1af0583061166e2ab05f43aa1dd
MD5 4735b2a113e7730f5ddd252ccb00bb12
BLAKE2b-256 7911d75c1d412d4237f40ac9088980012c8e1df81b01c5191180788128708c71

See more details on using hashes here.

File details

Details for the file omnara-1.6.21-cp310-cp310-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for omnara-1.6.21-cp310-cp310-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 35f5e15848349f05c208173c700aeced38066445f04de76ae347a8d64c528041
MD5 36516f6447a99aaa6c41ed8ed007f365
BLAKE2b-256 b88278338ea907840b2b1c7f0888d5423bf49b6f3744746cec79fc7ce5439735

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page