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.7

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

Uploaded CPython 3.13macOS 11.0+ ARM64

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

Uploaded CPython 3.13macOS 10.13+ x86-64

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

Uploaded CPython 3.12macOS 11.0+ ARM64

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

Uploaded CPython 3.12macOS 10.13+ x86-64

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

Uploaded CPython 3.11macOS 11.0+ ARM64

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

Uploaded CPython 3.11macOS 10.12+ x86-64

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

Uploaded CPython 3.10macOS 11.0+ ARM64

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

File metadata

  • Download URL: omnara-1.6.7.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.7.tar.gz
Algorithm Hash digest
SHA256 8afcd3748b8084e8b38612043ada7dfb6a02077c158408633f94cb0ab3041e88
MD5 579854ecc65824ef30e95a50d06838d5
BLAKE2b-256 a5449e0f8d95dbdeb6c226af238f38bc52205f71d1766b0608926b1dae7468cf

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.7-cp313-cp313-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 5137451bad129be6986990fe228044e1f6de4fa03a85a46c0affc8b548993899
MD5 bca5679e7ddbb58f27bbc01c800053d8
BLAKE2b-256 d65002d7b921bd8c578b6842660ea0e7df88485acc6e5f24cdbde2c868da45bb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.7-cp313-cp313-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 7e8f287c79d518b0b2ce12b663986256d157bd319aa69473d0b11a8efbb45913
MD5 05dee303f9c586056b5f5e2d17c99ebe
BLAKE2b-256 332b300df97d4963d2ac19128dcc91c0b857ff544789e01cba353c199b3d6c3e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.7-cp313-cp313-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 af63a85572cf2a3885ce9a49052645e00204353e39bce146c231f6e55a15c394
MD5 2c826ca906f96b8bd9e6274138086acc
BLAKE2b-256 fa4e7709eae4613f1fe045bd31cf86f859824e35d8bfe27365b7ca0d893972db

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.7-cp312-cp312-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 47db00bb252a4f79c32720f27640e316a13466f747e01bec5a9c8a472d821eae
MD5 45cfbe6574b1b273c32075b583463c36
BLAKE2b-256 b3aa95126cfae4d559987930dcc10e93e553b62be6a9648ccef9ab01ac8ee2a7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.7-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 26d967554f6f06e44f22910e4a1e4093ae0ba75765ab9517e2bf067092e9a5d4
MD5 0b8ddec0c2ffcac829b6ce3007b8c5c7
BLAKE2b-256 00ba29253b63bb5ace3cf1aea78ab3002d2dac6d26cdb707c5943f0e791638bb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.7-cp312-cp312-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 8baec43cd9bdeacd14207a5d3ae5ea4c2417c3fde7c593d3838798c97778314a
MD5 f01534f5e083ae67216f37fa78514f93
BLAKE2b-256 4832f03a044f09792d7db1777860b429277571be6c179be38c84fe97e027519f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.7-cp311-cp311-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 c5821d93cdfc75acc381d0396089a6ac072d0c355ed22d68ce0388058c7526aa
MD5 e8a4ef6e262d2195dd63234c5884e684
BLAKE2b-256 0a52c2c2ba5c24e8e6094c5f26012ac85dc3a18df437ee831c73f3c3f3a8ae8b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.7-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 9ecf381b07341da867a1022f9a2993aa5bef7986951c9670fa2ee7c856c414e7
MD5 ea9f65fe3e48934468b4739517b32866
BLAKE2b-256 398b04efe366cb95cc59cc36c3ad611a3a805ee20ff03fc0491bf9b663bc2c22

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.7-cp311-cp311-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 3ac8e789f16c9dc8e62593c4fe6656e480e849c2f03eddc30229712306a65827
MD5 fd242830dddeeaee20458aceb42785a5
BLAKE2b-256 70c27641f6f972a545b3d2a4d8ba535cb7c060544ccc531f1b4df990340ff87f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.7-cp310-cp310-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 ce830c84e3c04a95282137aa412eba97cc2341f044815b9c21cf9fd799e2810a
MD5 d0ea2c41ba7a5f48f4042227f7178354
BLAKE2b-256 bb283c92f5b4866440ff42340a328a6ef9c8502ef8b689bcfe0e1164775b1243

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.7-cp310-cp310-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 0fddcd66f2e2a99d2de43318e3ee373f727478c9f9d496a23c3b1060edc563b3
MD5 d23dfda426add3afbcf9d14dfd45b109
BLAKE2b-256 2534c22866253b0775a8f171ad90d879d1e01083490572d3584ed7aeb8a78e6d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.7-cp310-cp310-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 3cfd5e1682b4d49442294e73ca79e8522076d5f883b9507defba78ba1dfca8e5
MD5 f2cb94a8f1f6c6e0023c7aea62d7b252
BLAKE2b-256 f7c05d68d45075fb31c1cd62cc3550435462d15f9fa7913c85bcecadd659949a

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