CLI Commands
The Omnodex CLI is the primary interface for running tracing, detection, and reporting.
omnodex <command> [options]If you installed from source instead of npm, use npx omnodex in place of omnodex.
Commands
Section titled “Commands”install
Section titled “install”Install the Omnodex hook into an agent runtime.
omnodex install <target> [project]| Target | Description |
|---|---|
claude-code | Install as a Claude Code hook |
codex | Install as an OpenAI Codex hook |
antigravity | Install as a Google Antigravity hook |
| Flag | Description |
|---|---|
--debug | Enable verbose shim logging |
--project-settings | (claude-code only) Write to settings.json instead of settings.local.json |
--hooks | (antigravity) Install hooks only |
--mcp | (antigravity) Install MCP proxy only. Combine --hooks --mcp for both. Default (no flags): hooks only |
If project is omitted, defaults to the current working directory.
uninstall
Section titled “uninstall”Remove Omnodex hooks from a project.
omnodex uninstall [target] [project] --confirmIf target is omitted, removes all hooks found in the project. The --confirm flag is required to prevent accidental removal.
status
Section titled “status”Show current Omnodex status: which hooks are installed, event count, last activity.
omnodex status [project]detect
Section titled “detect”Run risk detection on all unanalyzed events.
omnodex detect [session]If a session ID is provided, only that session is scanned. Otherwise all sessions are scanned. Detection is idempotent - running it multiple times on the same events produces identical results.
dashboard
Section titled “dashboard”Start the local web dashboard with real-time updates.
omnodex dashboard [port] [--roots <path> ...] [--no-detect]| Option | Default | Description |
|---|---|---|
[port] | 7890 | Port for the dashboard web server |
--roots | (none) | Additional OMNODEX_HOME roots to tail. Space-separated paths. The default root is always included. |
--no-detect | (off) | Skip the historical detection pass on startup |
The dashboard automatically runs detection, replays events from all configured roots, and opens an SSE connection for live updates. See Using the Dashboard for multi-source aggregation details.
Cloud streaming: When OMNODEX_API_TOKEN and OMNODEX_SYNC_PASSPHRASE are set and your tier includes live streaming, the dashboard automatically encrypts and pushes events to the hosted dashboard at dashboard.omnodex.com in real time.
report
Section titled “report”Generate a text-based summary report of findings.
omnodex reportreplay
Section titled “replay”Replay the event log to rebuild the read model (SQLite database).
omnodex replayUseful if the database becomes corrupted or you want to apply updated rules to historical events.
Delete all event log data and the read model.
omnodex clear --all --confirmThe --confirm flag is required to prevent accidental data loss. This permanently deletes events.jsonl, omnodex.db, and related data under OMNODEX_HOME. Hook installations are not affected - use uninstall for that.
Run a mock pipeline that generates sample events for testing. Useful for verifying your installation works.
omnodex spike [name]If name is provided, the session ID is set to sess_<name>. Otherwise a unique timestamp-based ID is generated.
license
Section titled “license”Show current license tier and features.
omnodex licenseUse omnodex license clear to remove the cached license.
mcp-proxy
Section titled “mcp-proxy”Manage the MCP proxy interceptor.
omnodex mcp-proxy <subcommand>Run omnodex mcp-proxy help for subcommand details.
Environment Variables
Section titled “Environment Variables”| Variable | Default | Description |
|---|---|---|
OMNODEX_HOME | ~/.omnodex | Directory for event logs, database, and config |
OMNODEX_API_TOKEN | (none) | API token for cloud features (Hosted tier and above) |
OMNODEX_SYNC_PASSPHRASE | (none) | Passphrase for zero-knowledge encryption of cloud sync and live streaming |
Next Steps
Section titled “Next Steps”- Configuration - Configuration file options
- Quick Start - Get started with the CLI