Graft documentation
Back to the project README
New to Graft? Start with the two-and-a-half-minute video: how it works, who is involved and what changes for reviewers and agents.
Use and run Graft
| Page |
What is in it |
| getting-started.md |
Prerequisites, the offline quickstart in detail, tests, CI and every pnpm script. |
| github-app.md |
Registering a real GitHub App from the manifest, smee tunnel, the permissions and events table. |
| configuration.md |
Every environment variable with its default and rule, and the configuration files. |
| troubleshooting.md |
Common errors and what they mean. |
Features
| Page |
What is in it |
| features/provenance.md |
Graft-* trailers, agent or human, precedence, the commit hook. |
| features/intent-cards.md |
How a card is written and verified, the risk floor, rating cards, feedback internals. |
| features/policy.md |
graft.yaml in Phase 0 (report only), the CLI and the CI lint workflow. |
| graft-yaml.md |
The full graft.yaml v1 reference. Example: examples/graft.yaml. |
| features/evaluation.md |
pnpm eval: case sets, encryption, labeling, live runs, the synthetic CI baseline. |
| features/pilots-and-gate.md |
Pilot CLI, the Phase 0 gate, review-time baseline, rollup, incidents. |
| e2e.md |
The live end-to-end runner against a real sandbox repository. |
Internals
| Page |
What is in it |
| architecture.md |
Diagrams, modules, contracts (webhooks, LLM, managed comment, retention, replay, policy), source layout, data model. |
| decisions.md |
Library versions, library facts checked, and every deviation from the step specs, by step. |
Runbooks and reference material
| Page |
What is in it |
| pilots/onboarding.md |
Onboarding a pilot team: what Graft reads and stores, data sent to Anthropic, shadow mode, weekly ritual, offboarding. |
| pilots/ |
Starter policies: graft.service.yaml, graft.platform.yaml, graft.library.yaml. |
| e2e/runbook.md |
Running the live e2e suite step by step, and one section per failure code. |
| e2e/live-scenarios-spec.md |
Design of the live scenarios. Reviews: e2e/reviews/. |
| phase-0/labeling-guide.md |
How to label pull requests for the evaluation set. |
| phase-0/HUMAN-TODO.md |
Things only a person can do (App registration, keys, pilots, real-GitHub checks). |
Product and planning
Security reports: see SECURITY.md.