How to use these docs
Choose the right CompozyOS docs path for learning, operating, extending, and integrating with the daemon.
You do not need to learn all of CompozyOS before you get value from it. Use this page to pick the shortest path for the job in front of you: running your first session, operating a daemon day to day, extending the runtime, or integrating with the daemon.
Choose by goal
| Goal | Start here | What you should have after reading |
|---|---|---|
| Try CompozyOS for the first time | Quick Start | One daemon, one workspace, one durable session. |
| Understand what CompozyOS is | Overview | What comes built in, and when CompozyOS is the right fit. |
| Solve an operational problem | Guides | A decision path or debugging flow. |
| See CompozyOS in a realistic scenario | Use Cases | Concrete commands, checkpoints, and failure paths. |
| Learn the runtime model | Overview | Mental models for sessions, agents, 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. |
Recommended reading paths
I am new to CompozyOS
I operate CompozyOS day to day
I am integrating or extending CompozyOS
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. | Product explanation. |
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.
If a guide and a generated reference disagree, follow the generated contract for the immediate operation and report the conflicting guide. A failed documented step is a documentation defect, not a burden the reader should silently work around.