Flow Documentation#

Flow shows why a process was allowed to move forward — gate by gate, with the evidence behind each transition. This page is the map.

Learn Flow#

Getting Started — install → first run → evidence → route-back → resume, with real CLI output.
Use Cases — realistic team scenarios: agent guardrails, regulated releases, platform golden paths, adversarial review, audit evidence.

CLI Reference — every command, flag, format, and exit code.
Library — the typed API for embedding Flow: run lifecycle, validation, projections.
Evidence — evidence kinds, trust.bundle expectations, trust artifacts, claim diagnostics.
Live-Verify Gates — post-deploy contract verification through passive gates and external producers.
Gates & Route-Back — evaluation rules, exceptions, route-back policy, transition validation.
Agent Hooks — enforcing Flow gates from Claude Code hooks, GitHub Actions, and Git hooks.
Project Config — trusted producers, gate overrides, config merge preview/apply.
Runtime Roots — canonical generated Flow root, public path API, older-version migration, and rollback guidance.
Release Readiness — release lanes, pass/hold decisions, version release reports.
Flow Kit Container — the core kit manifest contract, validation rules, and extension model.

Product Vision — why Flow exists, differentiation, product-line fit, and ownership boundaries.
Developer Architecture — lifecycle and enforcement internals, run files, console projection, Resource Contract direction.

Contributing — local setup, validation lanes, optional repo hooks, release prep.
Repo Structure — where source, schemas, examples, tests, docs, and generated output belong.

Runtime and CLI behavior belongs in src/; public schemas in schemas/; published examples and scenarios in examples/.
Node tests belong in domain files under tests/node/; browser tests in tests/browser/; operational tooling in scripts/.
Durable product, architecture, contributor, and decision records belong in docs/. Update this map when adding, renaming, or retiring a guide.

Generated output and local runtime state stay out of source control unless a tracked fixture explicitly documents the exception.