Reference
The open-source project's own documents, vendored at the pinned release.
The open-source repository is the single source for the contract, the client and the operating documentation. These pages are the project's own documents at release v4.4.0 (commit c7573e1), the release this site is pinned to. Each page is the document at the pin, with its first heading as the page title and its links rewritten to this site or to GitHub at the pinned commit.
| Document | What it is |
|---|---|
docs/api.md | The HTTP API: routes, the envelope, identity and replay, status codes, the processed mark |
docs/operate.md | Running locally, bare binary or Docker, wiring harnesses, backups, restore and migration, upgrades, key rotation, retention, monitoring, uninstall |
docs/security.md | The trust boundary, what the client collects, credentials |
docs/sessions.md | Turning past coding-agent sessions into reports |
docs/releases.md | Versions, assets and upgrade notes |
AGENT-INSTALL.md | The client install playbook an agent follows |
AGENT-INSTALL-STACK.md | The server-and-client playbook |
docs/openapi.yaml and schemas/ | The contract itself, with the JSON schemas and the conformance kit every implementation passes |
llms.txt | The index of every machine-readable document, for agents |
The open-source server also serves the bundled OpenAPI document at /api/v1/openapi.json, the schemas at /api/v1/schemas, the skill at /skill and a discovery document at /.well-known/agentfeedback.json.