Skip to content

User documentation

End-user docs for Kneo Agent Dashboard — for operators, SREs, and reviewers running deployed Kneo agents.

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

Reading order

Daily operation

  1. Quickstart — run the BFF + SPA against a Kneo Agent Platform, ~10 min. (Prefer a guided, timed end-to-end path? The tutorial walks deploy → connect → launch → live trace → HITL → audit in under an hour — 0.8.0.)
  2. Connecting — the kneo-client profile, environments, the state store.
  3. Runs & debugging — Overview, the runs list, run detail (trace tail · checkpoints · replay/diff · graph · chain), run control, sessions, compare, launch.
  4. Human-in-the-loop — the reviewer queue, richer decisions, idempotent + bulk resume, near-deadline alerts.
  5. Audit & health — audit search/filter; health probes + subsystems.
  6. Policies & credentials — environment policy (view / dry-run / apply) and the presence-only credential inventory.
  7. Cost & spend — the approximate blended per-environment spend figure and the price book.
  8. Settings — the four dashboard-own cards (Connections · Access · Pricing · Preferences).

Operating in production

  1. Deployment — run the BFF (container / pip install), state store (SQLite vs Postgres), liveness/readiness probes, non-root.
  2. Observability & monitoring — the /metrics surface, what to watch, alerting.
  3. Security hardening & auth operations — the pre-launch checklist, OIDC vs static mode, sessions + secret rotation, reverse-proxy/TLS, and what an expired-session / cross-origin / role-escalation attempt does.
  4. Backup, restore & recovery — backing up the state store, the fail-safe restore procedure (recover → --reconcile), rollback, RPO/RTO, DR checklist.
  5. Data handling & retention — what the local store holds, retention, deletion limits.
  6. Upgrade — moving between versions (BFF + SPA + state-store migrations).
  7. Troubleshooting — common failures and how to trace them by request id.

Reference

  1. Environment variables — every setting the BFF reads, grouped by concern.
  2. CLI reference — the kneo-dash commands (serve, recover, prune).
  3. API reference — the browsable /api contract (generated from openapi.json).
  4. Examples & coverage matrix — worked scenarios + the page/router/capability→doc matrix.
  5. Accessibility — keyboard navigation, screen-reader support, contrast.

Covers the 0.7.0 operator surface — the full 0.4.0–0.6.0 platform surface (OIDC auth, server-side RBAC, the live env switcher, approximate cost, Settings, the recovery / break-glass path, the /metrics telemetry surface, and server-truth capability gating) plus 0.7.0's documentation-excellence + accessibility work: the new cost / settings / observability / data-handling / CLI / upgrade / troubleshooting / accessibility / examples guides, the browsable API reference, current-UI screenshots, and the WCAG-AA contrast pass. (Ships :: 3 - Alpha.)

Pages