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 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.16.tar.gz (114.1 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.16-cp313-cp313-manylinux_2_28_x86_64.whl (10.5 MB view details)

Uploaded CPython 3.13manylinux: glibc 2.28+ x86-64

omnara-1.6.16-cp313-cp313-macosx_11_0_arm64.whl (8.0 MB view details)

Uploaded CPython 3.13macOS 11.0+ ARM64

omnara-1.6.16-cp313-cp313-macosx_10_13_x86_64.whl (8.6 MB view details)

Uploaded CPython 3.13macOS 10.13+ x86-64

omnara-1.6.16-cp312-cp312-manylinux_2_28_x86_64.whl (10.5 MB view details)

Uploaded CPython 3.12manylinux: glibc 2.28+ x86-64

omnara-1.6.16-cp312-cp312-macosx_11_0_arm64.whl (8.0 MB view details)

Uploaded CPython 3.12macOS 11.0+ ARM64

omnara-1.6.16-cp312-cp312-macosx_10_13_x86_64.whl (8.6 MB view details)

Uploaded CPython 3.12macOS 10.13+ x86-64

omnara-1.6.16-cp311-cp311-manylinux_2_28_x86_64.whl (10.5 MB view details)

Uploaded CPython 3.11manylinux: glibc 2.28+ x86-64

omnara-1.6.16-cp311-cp311-macosx_11_0_arm64.whl (8.0 MB view details)

Uploaded CPython 3.11macOS 11.0+ ARM64

omnara-1.6.16-cp311-cp311-macosx_10_12_x86_64.whl (8.6 MB view details)

Uploaded CPython 3.11macOS 10.12+ x86-64

omnara-1.6.16-cp310-cp310-manylinux_2_28_x86_64.whl (10.5 MB view details)

Uploaded CPython 3.10manylinux: glibc 2.28+ x86-64

omnara-1.6.16-cp310-cp310-macosx_11_0_arm64.whl (8.0 MB view details)

Uploaded CPython 3.10macOS 11.0+ ARM64

omnara-1.6.16-cp310-cp310-macosx_10_12_x86_64.whl (8.6 MB view details)

Uploaded CPython 3.10macOS 10.12+ x86-64

File details

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

File metadata

  • Download URL: omnara-1.6.16.tar.gz
  • Upload date:
  • Size: 114.1 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.16.tar.gz
Algorithm Hash digest
SHA256 b6b4035267a3f01eb4daf48d60630957e7f146ad5d96655f0ff6b6332ae35b8e
MD5 3ffdcaa14e6990cab942b4131b919f8e
BLAKE2b-256 3762eec67a694ede32b4de6ef8753778b64c11443db08862f121f688ef636208

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.16-cp313-cp313-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 21fdf70b4276d2113a5beb62270053d00057c9bf68fe0e8c94057e3fec505859
MD5 616d4062ee27818100bf4420a27f52e6
BLAKE2b-256 c466d148bc945ce975ea9d7451c6dac1a0bcfdbefa0d1191e7b371e316f00d84

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.16-cp313-cp313-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 ea2ba075632a25be8889b1c9c1c248a4762a13ab9eca99f57fa13ac836acd303
MD5 870d8f6f0f7c21755718a59df5256a14
BLAKE2b-256 59b0886ea58b18df2a8b0b83b4baa0262693beac1a451508f8d1ea7dc6b7a158

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.16-cp313-cp313-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 dcdb65dd67c41fb27b48ba4804b995c07489173ef36e293ecebd042f885b04a4
MD5 8379c1788c5faaa216353025ce392d46
BLAKE2b-256 d4206030d49a22a33f5782c5a1665b9f3ec228c1e680aaa376f35a7e19fda9ca

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.16-cp312-cp312-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 2fe962336c8f642567f8dafb9d5bd1e45e0af1ed90b279ff1783013280398004
MD5 d9f1e44a2f3d7f13fa40ed6a6bfe9684
BLAKE2b-256 756a2627bbd288915324993ecd42ff4fa279bbb36ee41e922e329d92c0e491c2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.16-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 e83c02e01bd646465d5bbd71062c5da43807d04df7d2d6ff855a995095421fa9
MD5 70d1aa13eab249e68399633fe544f5c4
BLAKE2b-256 3c30a513370a91a1b9a0966b35d84674d6c7c8cef95769ac0ce568d5ccd1a0f8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.16-cp312-cp312-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 2fb1b83f209523a8a0a414d6e63e7d32a3b13b762b9173bf70a092235619f6b6
MD5 f6274ade18e53fd954418c5d075400fc
BLAKE2b-256 90f80b5c6f15cb27dee2bc935c5fcfcc884c0a851425ae91b275a41d73fdc2a4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.16-cp311-cp311-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 bfc96a23fd42d406a6f5182f662c4e8fe9f12e30654ffbb91791d90a584f3290
MD5 0d0e8c09c031a9d47472a602e48b8681
BLAKE2b-256 2d028f7751f3dd16c0dcc1d180b95aa87fe9e88bc83b66695902ac950ee85a0b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.16-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 e4df5215b3e63a47773853d1508b841aac2f6361c13a643d77e289c6eddf867e
MD5 0f07ca8be046b2c64db67d4952742b10
BLAKE2b-256 06ff453fa9ccc4e442642c5f27f955163a00084936f439505038610b7bbc2ba2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.16-cp311-cp311-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 11338ada4289f94061d1442bf6f7ad800fc70fb27e39e68ce32d120d35e23761
MD5 acb1598ff75229c94992dba106d6a18d
BLAKE2b-256 3ea25c04f01b3545744f6896ec6d9ee0f7bf30568ec3dbd17870e118eb186c43

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.16-cp310-cp310-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 8644aaa30ec86d76386e71423f063f0d54c40532a0bf2ab4b4d863f26058077a
MD5 30d777244c8ae1a55fdb6a2819a40a97
BLAKE2b-256 9b87fc1315b296ae87d8ab3286a0188077c974857873bfbe7832999158985917

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.16-cp310-cp310-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 528d197b49ac2d0b0f5642964320eb273b0f400ecd50476788679b46e8ef6155
MD5 1764516b161a90e4e640c63f3b1a7f88
BLAKE2b-256 e5cafb0adecd53402811e992661819e4d1a1208269402b16be88fd36c7733846

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.16-cp310-cp310-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 5e3581de56687fdc852634a2f46bfd2a39b1a4c93250108467d1c915862df5ef
MD5 6a50096a219d2d9da4f53f58a8464e86
BLAKE2b-256 1d82db6268dd887f7d4f38e0df809e0231ef1d3fb9beea49292971eb362e3545

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