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://api.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.13.tar.gz (112.9 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.13-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.13-cp313-cp313-macosx_11_0_arm64.whl (8.0 MB view details)

Uploaded CPython 3.13macOS 11.0+ ARM64

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

Uploaded CPython 3.13macOS 10.13+ x86-64

omnara-1.6.13-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.13-cp312-cp312-macosx_11_0_arm64.whl (8.0 MB view details)

Uploaded CPython 3.12macOS 11.0+ ARM64

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

Uploaded CPython 3.12macOS 10.13+ x86-64

omnara-1.6.13-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.13-cp311-cp311-macosx_11_0_arm64.whl (8.0 MB view details)

Uploaded CPython 3.11macOS 11.0+ ARM64

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

Uploaded CPython 3.11macOS 10.12+ x86-64

omnara-1.6.13-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.13-cp310-cp310-macosx_11_0_arm64.whl (8.0 MB view details)

Uploaded CPython 3.10macOS 11.0+ ARM64

omnara-1.6.13-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.13.tar.gz.

File metadata

  • Download URL: omnara-1.6.13.tar.gz
  • Upload date:
  • Size: 112.9 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.13.tar.gz
Algorithm Hash digest
SHA256 57d3a5b7255812660c950fc8d0febeeeea03c26d0e82732a174abf2043f9f355
MD5 819b2d47c6d47b8fa3b4a41c250bf4cb
BLAKE2b-256 c7fe54cf273dbdcc6436c5c23df494ff8f6cdc35d3168c8cdaf9c2739b5e69db

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.13-cp313-cp313-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 252903cf57ca2626aa19b1039d32dc74e9a8c8f26a084c90f4c7b0e1b13ddbbf
MD5 df0d19a4e7849fc500f65eb31adf814e
BLAKE2b-256 b62671863eaf1f18f968f97c42820deaf86ec288ff73ba28ed4d3d0e75bac1b0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.13-cp313-cp313-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 017846a8d24245ac33993e4ae38088e4cc2ab2a1f84718178f28a490945f8db0
MD5 67afb0f1716cdf86d192b07253203573
BLAKE2b-256 c295323db88d4d41a822d9f9baf4622ad7e6ab2eac0c0bb6a15d96941bf222b4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.13-cp313-cp313-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 cdcc84eb2994e41c55e4104364512c66a6975978b5dbe0db062766aa8d3235e6
MD5 d6e8b8b45729f8c51718116c4f4a325a
BLAKE2b-256 fc3fa1c538dd7b4432d1a1eeac086942baf3d9698dcb76e4554ee776a3f3487c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.13-cp312-cp312-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 aecc7fcd4aceae2a88eb5f2828806ea1af5db6b6a101d5c5b4b934096926a5b2
MD5 89c3add69c4dada3587d137d2d7d4e0c
BLAKE2b-256 fdd62fda70c08c8b9a4b8ebec3589e5fc58b77946ff2a8154110139a1e76901b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.13-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 71eb4f4f2e2db554a419452a958658bdc1234c3d40d55666e61621f5434bb8bc
MD5 386fd0a864f6bdec46d6ac90d088c14e
BLAKE2b-256 4ccf0a3c8e0639e9fae1262a7f749e7f321fbf9628683eeaea58c565b60afa09

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.13-cp312-cp312-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 fbfe43404627b754c24bd19ed1b5d4ec6b8c7dd7a32a9d779be1da8cbd303b27
MD5 fb1a5acee6551bc8231e5240f53d3f9a
BLAKE2b-256 39e7ce1daf9c66d2ebb53cd3e710bffd02056ab3487e3399ee04c73a00ebca65

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.13-cp311-cp311-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 77a4ed8013d8d1476484e8154cc7920ac5759648ed7254731ba551f0b39943d4
MD5 80e1f18d3ab0c80119313d127653f566
BLAKE2b-256 b5dc77c6aae1eab01d26e6696ff45f53614b931452769ed8436a6f9ab01beffa

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.13-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 0267314f640f4cf8724a6911290e5e32845f220b3d7e66d1a9cb72c51c8cc68a
MD5 9a40dc1bda9c6d454d9f45783eaf6243
BLAKE2b-256 a126a09a3369dc2b3109ebfb26abba3ef6cc683fc77e622d0d96cbe45295ac77

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.13-cp311-cp311-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 1fe42005cffb51fd988dd57be5bb619a7d718b10c17832141b73c18df140648a
MD5 7805b6bac888b6a4b6d99b612b299016
BLAKE2b-256 2125ad1fa43c6ad52c0f5ce885d40634e10fb8a5b8b1340452ba18a4f8305ed3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.13-cp310-cp310-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 ee5276c81c370276bbdc9ceeeebf2edaf69ece90a4e5a383d24825464389224e
MD5 591a8eb658c344406c947e7dc4bb670c
BLAKE2b-256 19608d2b610764dad96dfa864fd55bb9ded0004d2134eb429b3688853de445a2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.13-cp310-cp310-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 9471d8601389b8101d0610f571f71bde20e0f5bab566e0d5c931e69b3a33a705
MD5 7330159063f45ce3d5e1ce389fc8f41d
BLAKE2b-256 3fd863b3256dba906df60e3de54ac301326f607c616aa9e4be8342de271117a7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.13-cp310-cp310-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 a9611f2bea9a61490ac32eccd57eddcd3e020ee90f157b7f5f673b584c85d8f1
MD5 a3b22482478389f49d1f688f327304b8
BLAKE2b-256 37e3e2697dd0c34f6604fed07a995f708a11226ca11ff361f2954652b537d182

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