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.11.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.11-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.11-cp313-cp313-macosx_11_0_arm64.whl (8.1 MB view details)

Uploaded CPython 3.13macOS 11.0+ ARM64

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

Uploaded CPython 3.13macOS 10.13+ x86-64

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

Uploaded CPython 3.12macOS 11.0+ ARM64

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

Uploaded CPython 3.12macOS 10.13+ x86-64

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

Uploaded CPython 3.11macOS 11.0+ ARM64

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

Uploaded CPython 3.11macOS 10.12+ x86-64

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

Uploaded CPython 3.10macOS 11.0+ ARM64

omnara-1.6.11-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.11.tar.gz.

File metadata

  • Download URL: omnara-1.6.11.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.11.tar.gz
Algorithm Hash digest
SHA256 2e894a5dbb9262a9077ed863a1ba95ef1de4ac25e0b0cd638cb9bc91a5481e67
MD5 70d9b2464f2cb4191eb95fc31d25095d
BLAKE2b-256 8dc35861179f6827c1727109c8ca11171e60982dac6d1293fcb736de67e347e3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.11-cp313-cp313-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 c34b56f96ccf47aff2c2d0bb8624297a0b0b2e06370971c99015e053724763ae
MD5 3e161932bc7c612e472f3838ca34c12e
BLAKE2b-256 f0f6bb85e6d146cee49f2549b72b8c009f7f39d8cf2ec1dbb38fd774a63cce19

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.11-cp313-cp313-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 7e80d655754ca3c5992c76887dd615231dbd798b5cb6272ebdf48969c54cf56f
MD5 829ae8eb614468b940bdf3c0f2f7cfd0
BLAKE2b-256 6d5fd4eab3359bf9e0c8a79353d39ce49dc0c0f3dfff8a6ebdf910fb2098c69b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.11-cp313-cp313-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 5436f7d7800da85488726dc98207f73f645c367780f836c6433e1628b3ce67cc
MD5 f3b40b5357166e56b798925c95bbcc4a
BLAKE2b-256 809963b0680f2239c53946ed891c66eb8777c0fc7b540135b5bae9d4f0e1f1c4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.11-cp312-cp312-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 52d35cf7b4a920f240d711d384fcb3a270b94e5026c79b270aa2ca0e8f0f2a12
MD5 e46fc35733bce9fefddcb87a5c44dbf0
BLAKE2b-256 15d2bf9bf1c9b6f18540628ca3b3dfe7bc51b02f7ed34e453db81678ee28c306

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.11-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 b624e352567ff2bbe284cee2f213d3b87153b56ca3786d3787c67143a6faee07
MD5 909c5ee66cd9d24ea25e8509b889f458
BLAKE2b-256 6b4f7f7b36e9657b602e3e04ba69b778b52837d570e425a4f2ca3bffcad3db97

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.11-cp312-cp312-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 357fd3b85229fac56aecf7b0a0029de9f0369c39a4fbeb0c4565a29b31c34879
MD5 ee54caba3123b4130c552c4b29c96805
BLAKE2b-256 4f77a2ec4f9b6b06d950780e3e2fcde3e2174ac6dd1764b4113b56f0fee2133c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.11-cp311-cp311-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 aeff42902566414b3fb3b99f97989318ab3d0c36a1c6ea64123c0cd4059c386b
MD5 7c0a71ff9dec3024821d34246a916ba7
BLAKE2b-256 70997e42ff152fb0b91daeb42e51d93368673cef1a31ee46999b4534c56b1962

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.11-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 0657b9ae916d0ec2f7e2a38c76ba8aaf72d11b9ca8ff6b02a0ff9acee73d22f2
MD5 e854419f165a059def96ca7754a55e07
BLAKE2b-256 47f44c7ba69c8c1548e0ee2dc80a43342672e3bece34bddb2efb79a5efde76bf

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.11-cp311-cp311-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 aaf79266c136c7833438da8d128fff5c064f4a0939742a030b1ed9f63c8ff2da
MD5 2da5b7a980f34b5b9be29095f19206eb
BLAKE2b-256 ec6eb0b025833a29444b8126635e73b32bf942a75a7425a592f8b4c8b0dbf0c1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.11-cp310-cp310-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 1563b4a28fd8d0e618c9e7bdafe794d0029e7bc6edcd327f19582cf70f3e567e
MD5 3083971df6cf977d42483642c2066d6d
BLAKE2b-256 8dad4183c3482bdb7325cce11ec4f274e8c06297e9fa81e26cf9bcc6382d15b4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.11-cp310-cp310-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 171a43663b19d8af880ae374d7bf530277e6fb88cdbc78f2e88eece000200541
MD5 8fca2a33f35ba0bd7dbf574fa6d2c054
BLAKE2b-256 19ed456ff74228ad8a76422ea31b2a49074c08b2657918c8a7b9093ad54872cd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.11-cp310-cp310-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 feab775c0075a1d71952738a313a7304e0cef6cc135ca15af3dcbd189d140bef
MD5 50a1ede49b4c56569f4daf1cf064a8e0
BLAKE2b-256 a1083296630e7fa3634080aebda7dc89bbc5261cb6773d7e0c051f7ac6821e67

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