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.20.tar.gz (114.4 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.20-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.20-cp313-cp313-macosx_11_0_arm64.whl (8.1 MB view details)

Uploaded CPython 3.13macOS 11.0+ ARM64

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

Uploaded CPython 3.13macOS 10.13+ x86-64

omnara-1.6.20-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.20-cp312-cp312-macosx_11_0_arm64.whl (8.1 MB view details)

Uploaded CPython 3.12macOS 11.0+ ARM64

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

Uploaded CPython 3.12macOS 10.13+ x86-64

omnara-1.6.20-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.20-cp311-cp311-macosx_11_0_arm64.whl (8.1 MB view details)

Uploaded CPython 3.11macOS 11.0+ ARM64

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

Uploaded CPython 3.11macOS 10.12+ x86-64

omnara-1.6.20-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.20-cp310-cp310-macosx_11_0_arm64.whl (8.1 MB view details)

Uploaded CPython 3.10macOS 11.0+ ARM64

omnara-1.6.20-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.20.tar.gz.

File metadata

  • Download URL: omnara-1.6.20.tar.gz
  • Upload date:
  • Size: 114.4 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.20.tar.gz
Algorithm Hash digest
SHA256 bfb17a61afc3005d10f8d13fd721c538984e0a8c73ce1fa500937c0c15caf74a
MD5 29718820076fee15d90354c8dd891d03
BLAKE2b-256 739c005c8fca6941d5ebf12df7a49d1a1dc8bec984a53e8f5c5841da379cb6e4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.20-cp313-cp313-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 39f02c4d33d5b167f4ce8c6d9e37f4b1ef84075ca1e45a7750dd298005b030f4
MD5 154f94098b30d144c9c0c707359ce668
BLAKE2b-256 cd5212335ec40a6e7f8b70db6b8bb57c7941d1599772284c688d5a2516a653df

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.20-cp313-cp313-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 f778a5df57977e977fe3596767cad63fb5b829b14e15c20a31fda8eb555d8e3c
MD5 4aaa10616ed1ed081fd8b4ae13bf8a6d
BLAKE2b-256 43813c33f0d5606339144f7dff5be4bd2d110c3ae3bc6344e5a88d83e96bc243

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.20-cp313-cp313-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 8fdcaa3e3b2e7d00aefb834eee13b7f86208eed3d1a75d7890e0caad89ed5174
MD5 c26860c2ada998cfff247ebc416cbc28
BLAKE2b-256 2a34bcf63587a3962c13bccc7627f5421a7e4233de66bd77f57b291d57039ebd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.20-cp312-cp312-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 45268554eaa3f231d68e2fc4de3dd4affd27050ed31abe0dd1de070c14ef186b
MD5 5625e7576978a97dcceb230bd277e573
BLAKE2b-256 1b1e346a9fa6e3a88f9bb73b079c600cf1c3d30ac2c7a6082db12c825d480458

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.20-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 66f517b40cb151163213dea839bc17177e0ae9293fcb516cc1f0b4275dd99bae
MD5 95c7f525e6af5c1f8a4363de257be651
BLAKE2b-256 cb924ef29642f9dc4acbd09fa281cea40d6b7e79a90beb4d4544966f59c2f024

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.20-cp312-cp312-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 76c5fd45a88ecd07da679788741c6f0623f0f0494402c8389ab09d756df50c0f
MD5 83066e9636fff9393b8b3bfc556bf286
BLAKE2b-256 7ec14b5b1030fd814cb42cbaa90e33e4e15f68ba97495aa8d7dfb7d7cadadffd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.20-cp311-cp311-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 0e63dd41a5d42e7f6085156cc3a9d6682e5a4ebcc834a7f14605c3daa53c2795
MD5 7d898881541115975a7feb425e383a47
BLAKE2b-256 597d3cc2d682792f34aa8522e650dd05169a765031f9b1b8c5dbfcb9304602d9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.20-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 145348ab3f747c000e30b76de1f880ca26c10b656f5bd4b96fcd2bcb9cc58942
MD5 fe90e9b9f97095beff8467453147445d
BLAKE2b-256 4989e5134f155e53f9d388deca2cde3e497c2d65f9ff1bbd33e6ea5d45360032

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.20-cp311-cp311-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 f03bf98f256e8753e7497b527e912a100263ec954ddfc39cfef7750f7d0d97dd
MD5 bb501923965126bc5d6eafcde93ab997
BLAKE2b-256 2b2d1d95c2794fe532c51b56bbe704a7a9fd9afbf34c2d59d2cc3d1b2f3b3dec

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.20-cp310-cp310-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 c2c38b5e04da088a99f4a2c9bb743089ef7be878589346cad9a0ccacc11ba447
MD5 078dc9237715eb558f2faba13473db9c
BLAKE2b-256 57d58d5a9f24b64cd36e0b00996f3da8ec46333d7c0febefbc20eb8c187b5c2d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.20-cp310-cp310-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 0133975fb46c736258e70962cacd152397a390a338f60dbf8a058e05d0c3fc6f
MD5 44492fde98bf0c41082e9cdb28e5f363
BLAKE2b-256 904a94883a4fa73eaeb08d0c05db6483ae4600f0156775f3f9454dc8a06ec2ef

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.20-cp310-cp310-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 134e03f4c685bcaad3c7f5484e0a0c097f547d9d9a0c1f4b47de0f1b238465b1
MD5 3d17cdbb37806a37175f1e2cbd5a0e32
BLAKE2b-256 2a264caa44bdc8b9b1326362da8e0be81777f0469a71aaf56c04b35f9f72b8fa

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