Quick Start

Get OmniDev running quickly with a few commands.

1) Install the CLI

npm install -g @omnidev-ai/cli

Or with Bun:

bun install -g @omnidev-ai/cli

2) Initialize your project

omnidev init

This creates OMNI.md, omni.toml, and runtime files under .omni/.

3) Add a capability

Use the add command to register a capability and enable it in your active profile:

omnidev add cap my-cap --github user/repo

If the capability lives in a subdirectory:

omnidev add cap my-cap --github anthropics/skills --path skills/docx

4) Sync

omnidev sync

This fetches capabilities, generates instructions from rules and docs, and updates provider files.

5) Verify

omnidev doctor

If anything is missing, fix the config and rerun omnidev doctor.

Next steps

• Add more capability sources to omni.toml.
• Switch profiles with omnidev profile set <name>.
• Edit OMNI.md to refine project instructions.