Install
Get Omnigent running in a few minutes. Install the CLI, set up your credentials, and launch your first agent. Once it's running you can add the native macOS app for a full UI — it's the last step of this same flow.
Requirements
- Python 3.12+
- Node.js 22 LTS and npm
- tmux
Install Omnigent
curl -fsSL https://omnigent.ai/install.sh | shRun the same command to upgrade an existing installation.
Optional integrations
The base install covers everyday use. Optional integrations ship as
extras you opt into at install time. Pass one or more to the installer
script with --extra (comma-separate to add several):
curl -fsSL https://raw.githubusercontent.com/omnigent-ai/omnigent/main/scripts/install_oss.sh | sh -s -- --extra databricks
curl -fsSL https://raw.githubusercontent.com/omnigent-ai/omnigent/main/scripts/install_oss.sh | sh -s -- --extra modal,e2b
Available user-facing extras include:
- Model providers:
databricks,bedrock,vertex - Sandbox providers:
modal,daytona,boxlite,cwsandbox,e2b,openshell,kubernetes - SDK harnesses:
antigravity,copilot,cursor,agents-sdk - Storage and memory:
s3,hindsight
Manual installs use the same extras, expressed with the standard
package[extra,...] syntax:
uv tool install "omnigent[databricks,modal]"
Uninstall
omni uninstall removes Omnigent while preserving your data by default. With
no destructive flag it runs in dry-run preview mode, printing exactly what
it would do without changing anything:
omni uninstall
To actually remove the CLI and the installer-managed PATH entries — while
keeping your local history, credentials, and projects — add --yes:
omni uninstall --yes
To also delete Omnigent state under ~/.omnigent, add --purge. Omnigent
archives that state to a backup outside the target (under
~/.omnigent-backups/) and prints a restore command before deleting; pass
--no-backup to skip the archive. Your ~/omnigent workspace is kept unless
you also pass --purge-workspace:
omni uninstall --purge --yes
You can scope the run to one or more targets — cli, state, desktop-data,
or all — and other flags cover less common cases: --dry-run to force a
preview, --json for machine-readable output, --force to stop stubborn
processes and override tamper refusals, and --modify-external-config to allow
marker-scoped edits to third-party config files.
Standalone fallback
If the installed wheel is broken or omni is not on your PATH, run the
standalone script instead. Add --yes to perform the previewed cleanup:
curl -fsSL https://raw.githubusercontent.com/omnigent-ai/omnigent/main/scripts/uninstall_oss.sh | sh
Set up credentials
omni setup
The wizard detects credentials in your environment and prompts for any that are missing. See Models & Credentials for the full reference.
Launch Debby
Try your install with Debby, a built-in multi-AI agent that sends every question to both Claude and GPT and lets them debate.
omni debby
This launches a web UI and prints the server URL and port. Ask something
like What came first, the chicken or the egg? and watch the models
challenge each other. See the Debby reference
for more.
Add the macOS app
Prefer a native experience? The macOS app gives you a full UI, session history, and the ability to connect to a local or remote server — on top of the install you just set up. It's optional; everything above already works from the terminal.
Open the downloaded app — it will ask for a server URL. The omni debby
command above prints that URL when it launches the web UI. By default it is
http://localhost:6767. If port 6767 is already taken, the server uses the
next available port, so check the web UI for the actual URL (e.g.
http://localhost:6768). Paste that into the desktop app to connect.
Now your desktop app is ready to use. Pick Debby from the agent picker in the UI (along with the other agents we ship) and ask it anything.
This also works with a remote server. See Shared Server to learn how to deploy your own server.