Learn¶
Start here: the concepts, the quickstart, and a tutorial that builds one app chapter by chapter.
Where to start¶
| If you | Read |
|---|---|
| Have fifteen minutes and want to see it work | The Quickstart: a governed, traced and tested project from a template, offline |
| Want to learn it properly | The Tutorial: one app, built chapter by chapter, every feature, tested code |
| Want the mental model first | Concepts, then Lifecycle and hook points |
| Already have an app calling a model | Govern an existing client: three lines |
| Are on the platform or security team | Profiles and the org baseline, then Write an org baseline and Security |
| Aren't on Python | TypeScript, or any language through the harnessd sidecar |
Concepts¶
Background that the tutorial assumes, and explains again as it goes:
- Concepts: who writes what, the layers, and the twelve concepts.
- The spec: the documents, the YAML rules, the sections, and the files next to a spec.
- Lifecycle and hook points: the 13 hook points, a run end to end, event payloads, statuses and the trace.
- The hook bus: bands, the onion order, and how outcomes combine.
- Outcomes and errors: what middleware can answer, how a run ends, and the error taxonomy.
- Envelope, labels and budgets: who a run acts for, what it has seen, and what it may still spend.
- Integration styles: Wrap, Session and Run.
- Adoption levels: L0 to L4, and what each one needs.
After the tutorial¶
- The Advanced guide covers layering in depth, the tool governor, approvals in depth, TypeScript, the sidecar, and writing plugins.
- The HarnessWeaver CLI reference.
- Deployment and Recipes.