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

Uploaded CPython 3.13macOS 11.0+ ARM64

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

Uploaded CPython 3.13macOS 10.13+ x86-64

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

Uploaded CPython 3.12macOS 11.0+ ARM64

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

Uploaded CPython 3.12macOS 10.13+ x86-64

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

Uploaded CPython 3.11macOS 11.0+ ARM64

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

Uploaded CPython 3.11macOS 10.12+ x86-64

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

Uploaded CPython 3.10macOS 11.0+ ARM64

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

File metadata

  • Download URL: omnara-1.6.15.tar.gz
  • Upload date:
  • Size: 114.1 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.15.tar.gz
Algorithm Hash digest
SHA256 fac2e6c5f6acccbb9d05b2acf0cf459e864b7f9b470b7499ba18cd1a2a27005b
MD5 e3141503ef60859fb205d6bd76005b50
BLAKE2b-256 d6a7174dd66fdd5817c70b367e9e1cd56861e45169e7f9ac9961ef7ed04c5224

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.15-cp313-cp313-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 83214c2e0f466ad7d552a1051d7269c111c69ac415ddeb86288bf426ac84401b
MD5 7acdda3ca55a0fc5edd334c47773c39c
BLAKE2b-256 94e53ba4a94c3670a21734d80495f1878dcfd45b35617f18d37823ebbcc099f5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.15-cp313-cp313-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 eaa99a5eae6b190ea9d87872bc48f540dc186f86ff08bcd4f1082f97bc603426
MD5 e99937b44212207fa7a9b8b3b6d5efcc
BLAKE2b-256 069b17ae90b0217f5c055fe5ec62f025d6ca43b0f6f137f148915004d126f65b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.15-cp313-cp313-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 29580087eb3402a82cc9d46dd4c13c4c9cb892ca165bc57585027cbd1ed8b253
MD5 0c5b2380cd5bc59e863e2447b2cc0816
BLAKE2b-256 1c5f9ea3efc4252ccb2a28d0efa1390aab1d3f77a3ea6dd0cfed26fecc08d85e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.15-cp312-cp312-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 4457dd0b5d8317a94033b02329c26f3916c210183313c94785e624d8e13f9954
MD5 7049eea8c6ddc81dcb5e0709bb4d9f85
BLAKE2b-256 aed6e97c5e03b1bdd3c3554add2aa566bcecb88cf9ed06a6da25c1495927d7b2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.15-cp312-cp312-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 b32b0dc9ffa7e364a0e7728dbf6a936fca3e0a5e2c9c9ebf0a0d75724f68bd51
MD5 8ec6c1729fd3a429a1e33834e554a7a8
BLAKE2b-256 9a5e08c9feac3c8c5cb473bda62a9934b5806091fe6fa5bbfc4a2cf5685cccd1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.15-cp312-cp312-macosx_10_13_x86_64.whl
Algorithm Hash digest
SHA256 92565a2e07e74181f4f7180e53ef4792461bf107c1d0163e49bc330976bfb4ae
MD5 38a94a526857e00fbb81278befedf3fa
BLAKE2b-256 c5a7518faea5e81d1293b7326c42bf2a895148d767106b9979de35bce28fe0e3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.15-cp311-cp311-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 0dfdc8710ff55442b076288aa197aa5155dfa9f5331b0a307a3e48e90e1d9b49
MD5 2a662c951538350b557840202184fc80
BLAKE2b-256 22fd6cfac7399591da157ae199d76d67d059fe321a60d56ccf165ef0a12fbdc4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.15-cp311-cp311-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 493f5a6dfa35e729baa35c718c547cf6202ff403c5c59de7a4d203693c885766
MD5 86f0f45da41d48329f80f34a9912df11
BLAKE2b-256 428f3fcc5c676e9a9d402c1ba2181be1dadb073cdb3c57728d040cf8d7618cdc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.15-cp311-cp311-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 ba61c304a0923125c49917e031a9ac13e5ba93d26139053f32950c3338e74eed
MD5 85c64307adf92ae15edd8e01634db3c3
BLAKE2b-256 74f363b41b8923b0663da3fcd5cb2c863b625acf96f9563625eede69f56d9da4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.15-cp310-cp310-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 27917a4628c2c8b9ff131ba2b549af4b22cc25703596766dd36d5a182d81a8a4
MD5 3a744d7d8f40d83245a64f6306204caa
BLAKE2b-256 f53b9e14414481d27abba9acc1a146500ed86b6bce329bfc0681ba039582ce04

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.15-cp310-cp310-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 a247a59d57de69ddb10dd7608cec186c79727fb926f9eb0bcb2f4e91b349497e
MD5 017b2379d2b731ac37ab38783c5e5311
BLAKE2b-256 9b89b0effa1fd5fd9bc6333f45ad9a0550154f799c85cb8ba8f92f95a10920a0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for omnara-1.6.15-cp310-cp310-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 26aad2104c9194256f26cc6625ac7023c5b25afec1cad31d179be7ac21513c51
MD5 9fc8163c8f3c5893033d5bf1d21225da
BLAKE2b-256 44d53f2691ee2a198073a3a2cc55a2f49e63177b72d25cc359f752e1c3c4e068

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