CLI Commands
The Omnodex CLI is the primary interface for running tracing, detection, and reporting.
npx omnodex <command> [options]Commands
Section titled “Commands”install
Section titled “install”Install the Omnodex hook into an agent runtime.
npx omnodex install <target>| Target | Description |
|---|---|
claude-code | Install as a Claude Code hook |
codex | Install as an OpenAI Codex hook |
antigravity | Install as a Google Antigravity hook |
uninstall
Section titled “uninstall”Remove the Omnodex hook.
npx omnodex uninstall [--purge]| Flag | Description |
|---|---|
--purge | Also delete all event data and configuration |
status
Section titled “status”Show current Omnodex status: which hooks are installed, event count, last activity.
npx omnodex statusdetect
Section titled “detect”Run risk detection on all unanalyzed events.
npx omnodex detectDetection 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.
npx 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.
report
Section titled “report”Generate a text-based summary report of findings.
npx omnodex reportreplay
Section titled “replay”Replay the event log to rebuild the read model (SQLite database).
npx omnodex replayUseful if the database becomes corrupted or you want to apply updated rules to historical events.
Run a mock pipeline that generates sample events for testing. Useful for verifying your installation works.
npx omnodex spikeEnvironment Variables
Section titled “Environment Variables”| Variable | Default | Description |
|---|---|---|
OMNODEX_HOME | ~/.omnodex | Directory for event logs, database, and config |
Next Steps
Section titled “Next Steps”- Configuration - Configuration file options
- Quick Start - Get started with the CLI