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

This version

1.6.9

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.9.tar.gz (111.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.9-cp313-cp313-manylinux_2_28_x86_64.whl (10.7 MB view details)

Uploaded CPython 3.13manylinux: glibc 2.28+ x86-64

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

Uploaded CPython 3.13macOS 11.0+ ARM64

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

Uploaded CPython 3.13macOS 10.13+ x86-64

omnara-1.6.9-cp312-cp312-manylinux_2_28_x86_64.whl (10.7 MB view details)

Uploaded CPython 3.12manylinux: glibc 2.28+ x86-64

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

Uploaded CPython 3.12macOS 11.0+ ARM64

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

Uploaded CPython 3.12macOS 10.13+ x86-64

omnara-1.6.9-cp311-cp311-manylinux_2_28_x86_64.whl (10.7 MB view details)

Uploaded CPython 3.11manylinux: glibc 2.28+ x86-64

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

Uploaded CPython 3.11macOS 11.0+ ARM64

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

Uploaded CPython 3.11macOS 10.12+ x86-64

omnara-1.6.9-cp310-cp310-manylinux_2_28_x86_64.whl (10.7 MB view details)

Uploaded CPython 3.10manylinux: glibc 2.28+ x86-64

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

Uploaded CPython 3.10macOS 11.0+ ARM64

omnara-1.6.9-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.9.tar.gz.

File metadata

  • Download URL: omnara-1.6.9.tar.gz
  • Upload date:
  • Size: 111.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.9.tar.gz
Algorithm Hash digest
SHA256 ba3a7d65cb5b73026d0d68d61e1f27c76890dcf97f4fe28752ca644e7fc7adca
MD5 e1e46de34f2def634e1cfc68fe60eec3
BLAKE2b-256 05c2a5b6191ddb8ae1411c90309ad694fc001f7f00dcbc20b47528f9bcfd9eee

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.9-cp313-cp313-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 5a123287c558aca932f913812dc81907d40444b435594fb489a88030431e818b
MD5 9bab781b18ef1355978cafc0ce84fabe
BLAKE2b-256 df8ed1ecfd503b16a3c01893efe94186348f03fe64765a269764b8f016662a4a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.9-cp313-cp313-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 770b56ddbd2cf9a457b0d80503152f7da8df06b7a4a009f269bb4c2c424f99b7
MD5 9b39522770babb353fa887599ccb403a
BLAKE2b-256 7eeaafb69e4bd71a4654534c8b8cb3b99d62cf09e08559adefd8365da4c0c42d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.9-cp313-cp313-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 09b2b4787c37be5fd5a3f2e4fd3a2d3cdcf4a565d3681f6f4794d3b532bd81c8
MD5 ec1b72f6607129291f03523280fd3be1
BLAKE2b-256 f9b015f95a9a4a0c6a0b4a1f9ac2cf8f3850a707410402e21f192a47c20abeb1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.9-cp312-cp312-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 ef433b72a6f7b85b54dfb478497b11c35f44a3dbc5c63540413114e386c0e682
MD5 0df18b9ae166276fdbad1b7af93bd898
BLAKE2b-256 d9baa1b9cf9e18f971f288f1615bd276930f66e00c14a05a0c0d876c333e3872

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.9-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 185d0751e42058dc7c83b1368f7b3d024665c29ca186bf432dbc413cb3b06c0e
MD5 1c1f64436ca78f54c90d9a83897e8b23
BLAKE2b-256 9cef5d73a5af5794db5f8eab5f54144f2d07f633d5cd8545bcd58e6bb676e882

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.9-cp312-cp312-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 694df9ec2ceeae67440ae98918021c86d61356e1cb44d87418a1f7a4c286d092
MD5 de7d4bb1d7699201b1c5bc56eeea6360
BLAKE2b-256 012080306069f607d05628cf860731a571c7e46e9a3de78512ca26af3c6f8cca

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.9-cp311-cp311-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 bbcb2da2423d35e3c742ba34012a835be266e9dba230399fc678d217def76583
MD5 06636bac6748bbc1dd8555255147c6cd
BLAKE2b-256 7935a8cd9d9b7d262a397750d43468bb81ab389011ebd4c22b3f405991bde5ea

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.9-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 6eac72383f16284127f0f10c4a3a92ca831d102f54ed89555057d4fcd2e2662d
MD5 9af0395373f4b831f8fb28b19d453a2d
BLAKE2b-256 4d2165a298c36034853f1c1ad35f83343c1343601da5f2cf77c70bc71c9d39fb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.9-cp311-cp311-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 fb34aa9e34eec84e5ad31a89ce1ce4fb038b504da742511e5f71ddc52ce33f19
MD5 a0925e5f8d073faf1573944da8fe4436
BLAKE2b-256 52054362564d6ec5ee6e7b48b3936c0d5dc437951f5a6b0535313f0a0659609b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.9-cp310-cp310-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 d257f15684817c92bdf898a8b4f8fc09c5cc24e8c88aedaf815cfbc15aab9ee3
MD5 6df78eea02126464a0d978890094afeb
BLAKE2b-256 e282add290b017763ebfbef07f0f92c2f8b78107165da1aa5248bc27eca26ef0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.9-cp310-cp310-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 87d3eb70a279400238989626da2210d26b4e93b8955f9de0d64d85f1e15faa31
MD5 54aa6b55c800207d0c15de91c4802236
BLAKE2b-256 fbaf77d153c65499d9d13aa066b152c02fadd281248289a2e215af550a62195e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.9-cp310-cp310-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 297b657de6be172c1df879c91e7d37c1b1d3ad7addc0ab86e3e189d21047d249
MD5 90ea0ae04c3d8fc016b359fe568219ad
BLAKE2b-256 8d2cf35b7168cb853927578dba41b1cda41d876585ac90f79c597e61ed57ae65

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