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

omni init

Installs OMNI into an agent: writes the hook configuration where that host reads it, and registers the MCP server.

omni init              # interactive menu, or the current host when there is no terminal
omni init --claude
omni init --all

Idempotent. Running it again after an upgrade is the right move, not a risk.

With no flags

On a terminal, a menu. Without one, which is how an agent runs it, the menu cannot be drawn, so omni init configures the host it is running inside and prints which one that is. A host it cannot name from the environment, a plain shell included, gets an error listing the flags rather than a guess: installing into a host nobody asked for is the worse of the two failures.

Hosts

One flag per host. Each writes that host’s own configuration format in that host’s own location.

flaghost
--claudeClaude Code (Anthropic)
--cursorCursor
--zedZed
--clineCline
--roo, --roo-codeRoo Code
--copilotGitHub Copilot CLI
--geminiGemini CLI
--opencodeOpenCode
--codexCodex CLI
--openclawOpenClaw
--antigravityAntigravity IDE, and generic webhook
--hermesHermes Agent
--vscodeVS Code (MCP)
--piPi Agent

What each host actually lets OMNI do differs a great deal. See Supported agents before assuming a flag buys shell distillation.

Modes

flageffect
--allEvery host above. Also writes .vscode/mcp.json in the current directory.
--hookHooks only, no MCP registration
--mcpMCP registration only, no hooks
--statusReport what is currently installed, change nothing
--uninstallRemove OMNI’s hooks and MCP server
--help, -hHelp

After running it

omni doctor

Always. init reports what it wrote; doctor reports whether the host is reading it.

Codex CLI needs one more step. It runs only hooks it has been told to trust and skips the rest without a word. Start codex once and approve them under “Hooks need review”. omni doctor fails until you do.

Notes

--all is the only flag that writes into the current directory. Everything else touches your home configuration only.

An unrecognised host flag does not always fail loudly: a misspelled one has been known to run the interactive default and exit 0 while installing nothing that was asked for. Read what it printed.