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.14.tar.gz (113.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.14-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.14-cp313-cp313-macosx_11_0_arm64.whl (8.0 MB view details)

Uploaded CPython 3.13macOS 11.0+ ARM64

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

Uploaded CPython 3.13macOS 10.13+ x86-64

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

Uploaded CPython 3.12macOS 11.0+ ARM64

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

Uploaded CPython 3.12macOS 10.13+ x86-64

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

Uploaded CPython 3.11macOS 11.0+ ARM64

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

Uploaded CPython 3.11macOS 10.12+ x86-64

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

Uploaded CPython 3.10macOS 11.0+ ARM64

omnara-1.6.14-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.14.tar.gz.

File metadata

  • Download URL: omnara-1.6.14.tar.gz
  • Upload date:
  • Size: 113.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.14.tar.gz
Algorithm Hash digest
SHA256 43ee625e56ce15395de896eb51562618f08943b7eef0afc6d1fab3b72f6c30d4
MD5 83b8b67d51b0f2b7cbd4f7cd84178bef
BLAKE2b-256 d1a5a96baf161ea346b6742645da3c685cdbedd7d45c039fb2db7473936fdc7e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.14-cp313-cp313-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 e40afa9f106f3a82617d428b29628f97aa843749c2ea148bc6747b29ae670a61
MD5 bf4c1c6063198d3e1ff1bc598544f396
BLAKE2b-256 aa71b2e38206ddbdd8b05ccebbbe4a94f07ac20748b138b652df2615060b763f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.14-cp313-cp313-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 f31e0e125e7d62dc7102a1f30b7ca40a60c5ad5d26af8b1b27e2854c6705ef60
MD5 f866d7589011b3e742be1059627cc4cc
BLAKE2b-256 613f8c7749219188c09cbdef531c754adcff58f19bbc03266c9537040c84503c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.14-cp313-cp313-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 59a95692af5153e0c2600cc1b6c5bbc5eadcd00caf3c92c266618cfe4642ba72
MD5 ff54d3bd8ddc58653c3949c924d63692
BLAKE2b-256 de04d334f02d0953fbb8ea4a7b1fd920c1b48bbbec3da85f78e679a3c58e920a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.14-cp312-cp312-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 e75b33a9ff67998c45125e31fd0d9fc9ac0a3180b74e425254a4927ba9b45277
MD5 29b683c824519d4afa34661d8d7aa344
BLAKE2b-256 1c1d77b9b75057685bcf192f74b413667f72ad55a68cf514675d05a9afd3c008

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.14-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 59ef7dc21d89e4032d21edf2845c1025d3cea5b4d04afb01f597aba3d989c561
MD5 1235571db8d145ea1252b14d8c800684
BLAKE2b-256 2f110d5025268ccfb37ed73a0c568505991a24907735f37c734e1f021806fee2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.14-cp312-cp312-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 7ae50459e02d0ee2d674b7bff1072f1e3b788e0dfb0cd7bccec96877de989b62
MD5 6d821a72f707e34a9f2c3a513519ab52
BLAKE2b-256 edf441244f3ba5ef125eb7be38b35d1363fe2277afe67bece16ae855368521c2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.14-cp311-cp311-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 49b7d3749f72aed59adf0ac4d71c42a229cb9c864b56e7ea64572d180caa35bb
MD5 1dc2d569c1083c25ac238cdee71082cb
BLAKE2b-256 d28916afc6724162f34c8b2209cb205e31ce6e403159b4e4c43087822a1c70a6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.14-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 897f496c450f4358d096e0885bba6b2d1500ae791659091008fbfb9e4a297d54
MD5 830d1f0182253e9883bbb92b0ee3d91e
BLAKE2b-256 2281f573be9bd4ef08965eac08e2db050563f7049ed00ca045a46355c6f2e185

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.14-cp311-cp311-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 aaa940e9a2ee634e3a8f274d4afd937d605b37364a73cb874429eca878d40ac7
MD5 2d4ab72fc80556ed2804af36b376f9a3
BLAKE2b-256 d8b040df5ab70c94e9c98f144d1942bb1fbd20d7694f324547838be055a855c6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.14-cp310-cp310-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 2cdbf854a62218cc6f03f72bf29ff41d067c9ae6abbf207ab9b20f53bee411c1
MD5 bc000d21f0b33dfa21a85eb3e70dc24d
BLAKE2b-256 a35c633bd99d4a9ba9817c7186153b0d5b0bd573b58af70e8e039d19b50f268e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.14-cp310-cp310-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 fd071dc914a7c59bb6075728d156de1903882d6afb7d15663c4c839f813603d2
MD5 d6169cabe91e5cb3ace6e4926faa3491
BLAKE2b-256 aa52260e55361567962188c334c484590288700c3a7c08d7fcbb92710063bcee

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.14-cp310-cp310-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 13b47a3700b8fcdb253b1c105e3d0ac5b280cfec2d8aeb9781c7661b90a45429
MD5 9cb4925329dbdf79ceb47507903de759
BLAKE2b-256 cac75683b4d610c7ff92a31ef5fd4bff9d28e2251bfa21c60cd69a0d04b258ea

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