Skip to content

CLI Commands

The Omnodex CLI is the primary interface for running tracing, detection, and reporting.

Terminal window
omnodex <command> [options]

If you installed from source instead of npm, use npx omnodex in place of omnodex.

Install the Omnodex hook into an agent runtime.

Terminal window
omnodex install <target> [project]
TargetDescription
claude-codeInstall as a Claude Code hook
codexInstall as an OpenAI Codex hook
antigravityInstall as a Google Antigravity hook
FlagDescription
--debugEnable 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.

Remove Omnodex hooks from a project.

Terminal window
omnodex uninstall [target] [project] --confirm

If target is omitted, removes all hooks found in the project. The --confirm flag is required to prevent accidental removal.

Show current Omnodex status: which hooks are installed, event count, last activity.

Terminal window
omnodex status [project]

Run risk detection on all unanalyzed events.

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

Start the local web dashboard with real-time updates.

Terminal window
omnodex dashboard [port] [--roots <path> ...] [--no-detect]
OptionDefaultDescription
[port]7890Port 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.

Generate a text-based summary report of findings.

Terminal window
omnodex report

Replay the event log to rebuild the read model (SQLite database).

Terminal window
omnodex replay

Useful if the database becomes corrupted or you want to apply updated rules to historical events.

Delete all event log data and the read model.

Terminal window
omnodex clear --all --confirm

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

Terminal window
omnodex spike [name]

If name is provided, the session ID is set to sess_<name>. Otherwise a unique timestamp-based ID is generated.

Show current license tier and features.

Terminal window
omnodex license

Use omnodex license clear to remove the cached license.

Manage the MCP proxy interceptor.

Terminal window
omnodex mcp-proxy <subcommand>

Run omnodex mcp-proxy help for subcommand details.

VariableDefaultDescription
OMNODEX_HOME~/.omnodexDirectory 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