Skip to content

User documentation

End-user docs for Kneo Agent Platform. Two audiences live here — application developers writing YAML specs and calling the API, and operators / SRE deploying and running the service. Pick a reading order below.

For the top-level docs index see docs/README.md.

Application developer reading order

  1. quickstart.md — install to running, ~15 min.
  2. cli.md — CLI usage patterns; generated reference is cli_reference.md.
  3. service_api.md — HTTP API contract with curl examples.
  4. examples.md — annotated walk through examples/.
  5. tutorial_custom_tool.md — end-to-end custom-tool tutorial.
  6. human_in_the_loop.md — pause/resume walkthrough.
  7. project_config.md — .kneo/config.yaml reference.

Operator / SRE reading order

  1. tutorial_postgres_deployment.md — zero to running on PostgreSQL, ~30 min.
  2. deployment.md — Docker, Compose, persistence selection.
  3. environment.md — every environment variable.
  4. tls_and_proxy.md — reverse proxy, TLS termination, trusted-proxy headers.
  5. security_hardening.md — pre-launch hardening checklist.
  6. observability.md — structured logs, OpenTelemetry, what to watch.
  7. backup_and_recovery.md — backups, verified restore, rollback after a failed upgrade.
  8. upgrade.md — upgrade procedure and version-specific notes.
  9. incident_response.md — on-call triage tree and /readyz failure matrix.
  10. troubleshooting.md — symptom-indexed runbook.
  11. deployment_smoke.md — smoke-test command sequences.

Notes

  • cli_reference.md is generated by docs/script/generate_reference_docs.py. CI runs it with --check and fails on drift.
  • The HTTP API's raw OpenAPI spec lives at docs/pub/openapi.json.
  • Operator runbooks have a release-engineering counterpart in docs/plan/ — see release_checklist.md and staging_release_runbook.md.

Pages