---
compaction_strategy: structured
---

# omnius-docs

Find and use Omnius documentation without loading the whole docs tree.

## Triggers

- Omnius docs
- Omnius documentation
- how to use Omnius
- Omnius guide
- Omnius manual
- Omnius setup
- Omnius architecture

## Workflow

1. Start with `README.md` only for product overview and top-level docs map.
2. For setup questions, open `docs/getting-started/`.
3. For user workflows, open the relevant file under `docs/guides/`.
4. For commands, config, and API inventory, open `docs/reference/`.
5. For runtime and deployment questions, open `docs/operations/`.
6. For implementation shape, open `docs/architecture/overview.md`.
7. Read only the smallest relevant page before answering.

## Map

- Install: `docs/getting-started/install.md`
- First run: `docs/getting-started/first-run.md`
- Model providers: `docs/getting-started/model-providers.md`
- Realtime: `docs/guides/realtime.md`
- Sponsor and COHERE: `docs/guides/sponsor-and-cohere.md`
- Telegram: `docs/guides/telegram.md`
- Media generation: `docs/guides/media-generation.md`
- TUI workflows: `docs/guides/tui-workflows.md`
- REST API: `docs/reference/rest-api.md`
- Slash commands: `docs/reference/slash-commands.md`
- Configuration: `docs/reference/configuration.md`
- Runtime hygiene: `docs/operations/runtime-hygiene.md`
- Security and remote access: `docs/operations/security-and-remote-access.md`
- Architecture: `docs/architecture/overview.md`

## Canonical Sources

When documentation and code disagree, verify against the code or live daemon. REST machine contract lives in `packages/cli/src/api/openapi.ts`.
