Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Commands

Every subcommand, grouped the way omni --help groups them: by what you are trying to do, not alphabetically.

omni <COMMAND> [FLAGS]
cmd | omni                # distill any command's output through a pipe

Set up

commandwhat it does
initInstall OMNI into your agent, hooks and MCP
doctorCheck the install is healthy, and fix what is not
updateUpgrade to the latest release
resetUninstall cleanly, keeping a backup of your config

See what it saved

commandwhat it does
statsHow many tokens were cut, and from which commands
retrievePrint the content a marker archived, by its handle
dashboardThe same numbers in a browser, on 127.0.0.1
diffThe last command’s output, before against after
sessionWhat this session has spent, and on what

Tune it

commandwhat it does
execRun one command through OMNI, to see what it would do
querySearch past distillations
patternsErrors that keep coming back

Memory

commandwhat it does
rememberSave a fact for future sessions
engramDigests of finished subtasks
goalPin a north-star goal so scoring favours it
versionVersion and environment details

Hook entry points

Not for typing. These are what an agent host invokes, and they are documented in Hooks.

omni --pre-hook      omni --post-hook     omni --hook
omni --session-start omni --session-end   omni --pre-compact
omni --mcp

A note on how flags are parsed

A match on the first argument routes the subcommand and hands the module the raw env::args(), so every module parses its own flags and declares its own accepted set. cli::check_flags rejects anything outside that set, which is what stops omni stats --detial printing the default overview and exiting 0.

Per-command help is real and worth reading: omni <command> --help. Where this reference and the help disagree, this records what the source accepts.