Compare commits

...

11 Commits

Author SHA1 Message Date
Dhruv Gupta d5d94c309b docs(readme): trim badges to PyPI, License, Discord, Status
Co-authored-by: Isaac
2026-06-26 21:33:36 +00:00
Dhruv Gupta 483d60af56 docs(readme): drop desktop-app bullet, label hermes as "Hermes Agent", refresh hero
Co-authored-by: Isaac
2026-06-26 21:31:26 +00:00
Dhruv Gupta 150744d5e9 docs(readme): update desktop-app hero screenshot
Co-authored-by: Isaac
2026-06-26 21:25:36 +00:00
Dhruv Gupta 5d8708463c docs(readme): drop AWS Bedrock from the credentials table
Co-authored-by: Isaac
2026-06-26 21:19:53 +00:00
Dhruv Gupta 1a22ca8d67 docs(readme): add desktop-app screenshot as the hero image
Co-authored-by: Isaac
2026-06-26 21:19:33 +00:00
Dhruv Gupta 602e3a310d docs(readme): add Discord badge; swap hero for desktop-app screenshot placeholder
Discord invite from omnigent-ai/omnigent-site (components/links.js). Hero now
points at docs/images/omnigent-desktop.png (terminal view in the desktop app)
— image to be dropped in.

Co-authored-by: Isaac
2026-06-26 21:05:43 +00:00
Dhruv Gupta 576a57ee5a docs(readme): add PyPI version and GitHub tag badges
Co-authored-by: Isaac
2026-06-26 21:04:04 +00:00
Dhruv Gupta eae552a05e docs(readme): drop "AI agent framework" framing, call it just the meta-harness
Reverts the SEO framing from #520; Omnigent is described as an open-source
meta-harness.

Co-authored-by: Isaac
2026-06-26 20:51:42 +00:00
Dhruv Gupta c45a2cfcbe docs(readme): trim launch examples
Drop the agent.yaml line from the runtime-launch box and collapse the
Polly/Debby cross-harness examples to one generic line each.

Co-authored-by: Isaac
2026-06-26 20:47:54 +00:00
Dhruv Gupta 5626af9300 docs(readme): drop Scribe from the example-agents section
Co-authored-by: Isaac
2026-06-26 20:44:06 +00:00
Dhruv Gupta 32696eace7 docs(readme): refresh for 0.3.0 — harnesses, sandboxes, deploy targets
Bring the README up to date with the 0.3.0 feature set, scoped to what we
fully support:

- lead with the harnesses that have full native support in 0.3.0 (Claude
  Code, Codex, Cursor, Hermes, OpenCode, Pi) across the intro, launch
  examples, prerequisites, and the agent-YAML `harness:` list; the
  limited-support natives (kimi, qwen, goose, antigravity, kiro) are no
  longer advertised as first-class
- make the macOS desktop app more visible (tagline + a dedicated bullet)
- add Databricks to the cloud-sandbox list
- add Railway, Cloudflare, Databricks Apps, and the Cloudflare/Tailscale
  local-expose paths to the deploy menu
- add the AWS Bedrock credential kind
- surface MCP tools in "Write your own agent"
- drop the cursor/copilot auth-hint comments in the cross-harness example

Co-authored-by: Isaac
2026-06-26 20:42:07 +00:00
2 changed files with 51 additions and 48 deletions
+51 -48
View File
@@ -2,20 +2,21 @@
# <img src="https://raw.githubusercontent.com/omnigent-ai/omnigent/main/docs/images/omnigent-logo.svg" alt="" height="38" valign="middle" /> Omnigent
### The open-source AI agent framework and meta-harness for all your AI agents.
### The open-source meta-harness for all your AI agents.
Omnigent is an open-source **AI agent framework** and meta-harness that gives you a common orchestration layer over Claude Code, Codex, Cursor, Kimi Code, Pi, and the agents you write yourself: swap or combine harnesses without rewriting, enforce policies and sandboxing, and collaborate in real time from any device.
Omnigent is an open-source **meta-harness** that gives you a common orchestration layer over Claude Code, Codex, Cursor, OpenCode, Hermes, Pi, and the agents you write yourself: swap or combine harnesses without rewriting, enforce policies and sandboxing, and collaborate in real time from any device — terminal, browser, phone, or the native desktop app.
[![PyPI version](https://img.shields.io/pypi/v/omnigent.svg)](https://pypi.org/project/omnigent/)
[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/omnigent-ai/omnigent/blob/main/LICENSE)
[![Discord](https://img.shields.io/badge/Discord-join-5865F2?logo=discord&logoColor=white)](https://discord.gg/omnigent)
![Status: alpha](https://img.shields.io/badge/status-alpha-orange.svg)
[![Python 3.12+](https://img.shields.io/badge/python-3.12%2B-blue.svg)](#1-install)
[omnigent.ai](https://omnigent.ai) · **[⬇️ Download the macOS desktop app](https://omnigent.ai/download/mac)**
</div>
<p align="center">
<img src="https://raw.githubusercontent.com/omnigent-ai/omnigent/main/docs/images/omnigent-hero.png" alt="An Omnigent orchestrator and its sub-agents in one shared session" width="520" />
<img src="https://raw.githubusercontent.com/omnigent-ai/omnigent/main/docs/images/omnigent-desktop.png" alt="The Omnigent desktop app: starting a new session, with pinned and project-grouped sessions in the sidebar" width="720" />
</p>
---
@@ -28,10 +29,10 @@ Omnigent lets you:
follow you: start in your terminal, continue in the browser, pick it up on
your phone. Messages, sub-agents, terminals, and files stay in sync.
- **🤖 Supervise multiple agents.** Use Claude Code, Codex, Pi, and custom
agents (defined in YAML) together in the same session. Ask one agent to
review another's work, or split a task across agents that are each good at
different things.
- **🤖 Supervise multiple agents.** Mix Claude Code, Codex, Cursor, OpenCode,
Hermes, Pi, and custom agents (defined in YAML) together in the same
session. Ask one agent to review another's work, or split a task across
agents that are each good at different things.
- **🔌 Use any model.** A first-party API key, a Claude/ChatGPT subscription,
or any compatible gateway. All first-class.
@@ -45,7 +46,8 @@ Omnigent lets you:
[Islo](https://islo.dev), [E2B](https://e2b.dev),
[CoreWeave](https://docs.coreweave.com/products/sandboxes),
[Kubernetes](https://kubernetes.io), [OpenShell](https://github.com/NVIDIA/OpenShell),
or [Boxlite](https://github.com/boxlite-ai/boxlite) sandboxes, launched from the
[Boxlite](https://github.com/boxlite-ai/boxlite), or
[Databricks](https://www.databricks.com) sandboxes, launched from the
CLI or provisioned by the server per session (*managed hosts*).
- **🛡️ Govern your agents.** Create
@@ -94,17 +96,16 @@ uv tool install -q --python 3.12 git+https://github.com/omnigent-ai/omnigent.git
- **`uv`** (required). https://docs.astral.sh/uv/getting-started/installation/
The installer offers to set this up for you.
- **`git`** (required).
- **Node.js 22 LTS or newer** with **`npm`**, for the Claude, Codex, and Pi
coding harnesses. `omnigent run` installs the harness CLI you pick.
- **Node.js 22 LTS or newer** with **`npm`**, for the npm-installed coding
harnesses (Claude, Codex, OpenCode, Pi). `omnigent run` installs the
harness CLI you pick.
https://docs.npmjs.com/downloading-and-installing-node-js-and-npm
- **Kiro CLI** (optional), for `omnigent kiro`: install with
`curl -fsSL https://cli.kiro.dev/install | bash`, then sign in with Kiro.
- **`tmux`**, required by the native `omnigent claude` / `omnigent codex` /
`omnigent kiro`
wrappers (`brew install tmux` / `apt install tmux`; the installer offers
- **`tmux`**, required by the native `omnigent <harness>` terminal wrappers
(`claude`, `codex`, `cursor`, `hermes`, `pi`)
(`brew install tmux` / `apt install tmux`; the installer offers
to install it for you).
- **`bubblewrap`** (`bwrap`), **Linux only**. The native `omnigent claude` /
`omnigent codex` / `omnigent kiro` and `pi` harnesses wrap each agent
- **`bubblewrap`** (`bwrap`), **Linux only**. The native `omnigent <harness>`
terminal wrappers and the `pi` harness wrap each agent
terminal in a `bwrap` OS-sandbox; on Linux that isolation is mandatory, so a
missing `bwrap` binary makes those terminals fail to start
(`apt install bubblewrap`; the installer offers to install it for you). macOS
@@ -130,8 +131,8 @@ uv tool install --python 3.12 git+https://github.com/omnigent-ai/omnigent.git
```
What works on Windows: `omnigent server`, the web UI, and the SDK-based
harnesses (`omnigent run <agent.yaml>` with the claude-sdk / cursor / copilot
/ codex harnesses). Agents run under a Windows **Job Object** for process-tree
harnesses (`omnigent run <agent.yaml>` with the claude-sdk / cursor / codex
harnesses). Agents run under a Windows **Job Object** for process-tree
containment.
What is **not** available on Windows (use Linux/macOS, or WSL, for these):
@@ -189,30 +190,28 @@ in a native window and adds OS notifications and a dock badge —
omnigent
```
Or launch a specific agent runtime, or your own agent:
Or launch a specific agent runtime:
```bash
omnigent claude # Claude Code, in a session your team can join
omnigent codex # Codex
omnigent kiro # Kiro CLI
omnigent kimi # Kimi Code (https://kimi.com), headless
omnigent run path/to/agent.yaml # your own agent (see "Write your own agent")
omnigent cursor # Cursor
omnigent opencode # OpenCode
omnigent hermes # Hermes Agent (Nous Research)
omnigent pi # Pi
```
#### 🐙 Polly, 🟠🔵 Debby, and ✍️ Scribe
#### 🐙 Polly and 🟠🔵 Debby
Three example agents ship with the repo, and they make good first sessions:
Two example agents ship with the repo, and they make good first sessions:
```bash
omnigent run examples/polly/
omnigent run examples/debby/
omnigent run examples/scribe/
# Run an orchestrator on a different harness (sub-agents keep their own):
omnigent run examples/polly/ --harness pi
omnigent run examples/debby/ --harness openai-agents
omnigent run examples/polly/ --harness cursor # Cursor CLI (needs cursor-agent + CURSOR_API_KEY)
omnigent run examples/polly/ --harness copilot # GitHub Copilot SDK (needs a GitHub token w/ Copilot, e.g. GH_TOKEN)
# ...or on a different harness (sub-agents keep their own):
omnigent run examples/polly/ --harness <harness>
omnigent run examples/debby/ --harness <harness>
```
**🐙 Polly** is a multi-agent coding orchestrator who writes no code herself.
@@ -226,13 +225,6 @@ side by side. Type `/debate` and the heads critique each other for a few
rounds before converging. (She needs both a Claude and an OpenAI credential;
see step 3.)
**✍️ Scribe** is a documentation orchestrator, the docs counterpart to Polly.
She turns git diffs, commit history, and PRs into release notes, changelogs, and
migration guides. She authors the prose herself and delegates only read-only
code investigation to a researcher sub-agent, then can route a draft through an
independent different-vendor reviewer to fact-check its claims before it ships.
(The cross-model fact-check needs an OpenAI credential; the rest runs on one.)
**Prefer the browser?** Start a server and register your machine as a host:
```bash
@@ -289,10 +281,14 @@ mobile, so you get the same chat, sub-agents, terminals, and files, in sync
with your laptop.
One `docker compose up` runs the server on any host you have (a VPS, a home
server); Render deploys with one click; Fly.io, Railway, Hugging Face Spaces,
and Modal are covered too. The server can also provision a cloud sandbox per
session (*managed hosts*), so no laptop has to stay online. The full menu of
targets, the database options, and the sandbox setup live in
server); **Render** and **Railway** deploy with one click; **Fly.io**, **Hugging
Face Spaces**, **Modal**, **Cloudflare** (serverless, scale-to-zero), and
**Databricks Apps** (backed by Lakebase Postgres and Unity Catalog Volumes) are
covered too — and a **Cloudflare quick tunnel** (public) or **Tailscale**
(private) reaches a server running on your own laptop without a deploy. The
server can also provision a cloud sandbox per session (*managed hosts*), so no
laptop has to stay online. The full menu of targets, the database options, and
the sandbox setup live in
[`deploy/README.md`](https://github.com/omnigent-ai/omnigent/blob/main/deploy/README.md).
Once the server is up, sign in and register your laptop as a host:
@@ -401,17 +397,19 @@ See the [policy guide](https://github.com/omnigent-ai/omnigent/blob/main/docs/PO
## Write your own agent
An agent is a short YAML file: your prompt, your tools, and optional helper
sub-agents a supervisor can delegate to. You don't have to write it by hand:
agents can build agents, so describe the agent you want in any Omnigent chat
and it authors the file for you.
An agent is a short YAML file: your prompt, your tools — local Python
functions, MCP servers, and sub-agents a supervisor can delegate to. You don't
have to write it by hand: agents can build agents, so describe the agent you
want in any Omnigent chat and it authors the file for you.
```yaml
name: my_agent
prompt: You are a helpful data analyst.
executor:
harness: claude-sdk # or: claude-native, codex, codex-native, cursor, cursor-native, kiro-native, openai-agents, pi, pi-native, antigravity, qwen, kimi, copilot
harness: claude-sdk # or: claude-native, codex, codex-native, cursor,
# cursor-native, hermes, hermes-native, opencode,
# pi, pi-native, openai-agents
tools:
# A local Python function (schema auto-generated from the signature)
@@ -419,6 +417,11 @@ tools:
type: function
callable: mypackage.mymodule.word_count
# Tools from an MCP server (a local command, or a remote URL)
docs:
type: mcp
url: https://example.com/mcp
# A sub-agent the supervisor can delegate to
researcher:
type: agent
Binary file not shown.

After

Width:  |  Height:  |  Size: 977 KiB