How to Use These Docs
Choose the right Compozy Runtime docs path for learning, operating, extending, and integrating with the daemon.
- Audience
- Operators running durable agent work
- Focus
- How To Use These Docs guidance shaped for scanability, day-two clarity, and operator context.
Compozy has several surfaces because the runtime has several jobs: it runs agent sessions, preserves history, manages workspace context, exposes a daemon API, and lets agents and extensions manage runtime state. You do not need to understand all of that before starting.
Use this page to pick the shortest path for the work in front of you.
Choose by goal
| Goal | Start here | What you should have after reading |
|---|---|---|
| Try Compozy for the first time | Quick Start | One daemon, one workspace, one durable session. |
| Understand what Compozy is | Runtime Overview | The operating model and when Compozy is the right fit. |
| Solve an operational problem | Guides | A decision path or debugging flow. |
| See Compozy in a realistic scenario | Use Cases | Concrete commands, checkpoints, and failure paths. |
| Learn the runtime model | Runtime Overview | Mental models for sessions, agents, memory, network, resources, and extensions. |
| Look up an exact CLI flag | CLI Reference | Generated command syntax and options. |
| Integrate with the daemon over HTTP or UDS | API Reference | Route families, stream surfaces, and caveats. |
| Implement the open agent network protocol | Protocol Overview | Wire-level protocol concepts and conformance path. |
Recommended reading paths
I am new to Compozy
I operate Compozy day to day
I am integrating or extending Compozy
I am coordinating multiple agents
How the sections differ
| Section | Best for | Avoid using it for |
|---|---|---|
| Tutorials | First successful run. | Exhaustive reference. |
| Guides | Choosing what to do next for one problem. | Learning every subsystem detail. |
| Use cases | Seeing complete operator scenarios. | Exact flag lookup. |
| Core Concepts | Understanding the model behind a feature. | Copy-paste-only command runs. |
| CLI Reference | Flags, syntax, output formats, and generated commands. | Product explanation. |
| API Reference | Route families and streaming surfaces. | Complete generated schema coverage for every route yet. |
| Protocol | Interoperability outside Compozy Runtime. | Operating the local daemon day to day. |
When docs disagree
Runtime truth wins:
- Generated CLI reference wins for command names and flags.
- Implemented code and generated contracts win for API behavior.
- Core concept pages explain intent, but should not override generated references.
- Protocol pages define wire contracts for interoperable runtimes, not necessarily every Compozy Runtime feature.
If a guide gives a command that fails, check the generated CLI page for that command and treat the guide as stale.