Runtime Guides
Goal-oriented guides for running, debugging, and coordinating real Compozy work without reading the full reference first.
Runtime Guides are problem-oriented. Use them when you already know what you want Compozy to do and need the shortest reliable path through the daemon, CLI, API, and web surfaces.
Pick the job
Build your first extension
Scaffold, link, and invoke a working extension in three commands, then iterate with edit and reload.
Choose the right control surface
Decide when to use CLI, HTTP/SSE, UDS, or the web UI for humans, scripts, and agent-managed work.
Debug a failed or stuck session
Walk from daemon health to session status, event history, repair, and stored runtime files without guessing.
Coordinate agents over Compozy Network
Turn durable sessions into peers, inspect channels, send a direct envelope, and follow receipts and traces.
What belongs here
Guides focus on operator outcomes:
- choose the Compozy surface that matches the actor and task
- recover a session or daemon state you can prove from events
- connect sessions, peers, and task handoff through Compozy Network
- route from a scenario into generated CLI/API reference only when exact syntax matters
If you are brand new to Compozy, start with Quick Start. If you need exact machinery, use the CLI Reference and API Reference.