OMK Documentation

OMK is a provider-neutral coding agent with multi-agent orchestration, durable harness controls, replayable sessions, SDK/RPC integration, and evidence-backed verification. Its core stays small while extensions, skills, prompts, themes, and packages add workflows.

Quick start

Install OMK with npm:

npm install -g --ignore-scripts open-multi-agent-kit

--ignore-scripts disables dependency lifecycle scripts during install. OMK does not require install scripts for normal npm installs.

To uninstall omk itself, use npm:

npm uninstall -g open-multi-agent-kit

For pnpm, Yarn, or Bun installs, use the matching global remove command: pnpm remove -g open-multi-agent-kit, yarn global remove open-multi-agent-kit, or bun uninstall -g open-multi-agent-kit.

Then run it in a project directory:

omk

Authenticate with /login for subscription providers, or set an API key such as ANTHROPIC_API_KEY before starting omk.

For the full first-run flow, see Quickstart.

Start here

• Quickstart - install, authenticate, and run a first session.
• Using OMK - interactive mode, /goal, default harness safeguards, context files, and CLI reference.
• Providers - subscription and API-key setup for built-in providers.
• Provider Resilience - retry, failover, quota, and safety-stop recovery.
• Native xAI Grok - authentication, weekly SuperGrok usage, presets, and thinking tiers.
• Containerization - sandbox omk with OpenShell, Gondolin, or Docker.
• Settings - global and project settings.
• Environment Variables - process configuration, harness opt-outs, and bash-tool session environment.
• Keybindings - default shortcuts and custom keybindings.
• Sessions - session management, branching, and tree navigation.
• Compaction - context compaction and branch summarization.

Customization

• Extensions - TypeScript modules for tools, commands, events, and custom UI.
• Skills - Agent Skills for reusable on-demand capabilities.
• Book to Skill - optional document-to-skill compiler with local provenance checks.
• Prompt templates - reusable prompts that expand from slash commands.
• Themes - built-in and custom terminal themes.
• OMK packages - bundle and share extensions, skills, prompts, and themes.
• Custom models - add model entries for supported provider APIs.
• Custom providers - implement custom APIs and OAuth flows.

Automation and control

• SDK and Session Control - embed omk, reuse policy helpers, or inspect stored sessions from scripts.
• Run Protocol and Durable Goals - canonical run contracts and the durable-goal lifecycle.
• RPC mode - integrate over stdin/stdout JSONL.
• JSON event stream mode - print mode with structured events.
• TUI components - build custom terminal UI for extensions.

Reference

• Session format - JSONL session file format, entry types, and SessionManager API.

Platform setup

• Windows
• Termux on Android
• tmux
• Terminal setup
• Shell aliases

Development

• Development - local setup, project structure, and debugging.