Who it is for
How the book is written
- Every statement is checked against the code. Where the book and the code disagree, the code wins and the book is fixed. Anything not verified in production says so.
- The reference chapters are generated from the code. Every endpoint,
every SDK method and every error code are produced by
scripts/generate-build-book-reference.tsfrom the OpenAPI file, the SDK source and the server’s error classes. A test fails when they fall behind the code. - Examples are real. Responses are captured from the running server; tutorial output is what the tutorial prints.
- Procedures state what to expect. Where a step can fail, it says what you see and what to do.
The chapters
- How Parmana works: one request, from an agent to a signed record.
- Your first governed action: run it on your machine in minutes.
- Connect an agent: the request, the policy in effect, approvals, in both SDKs.
- Policies: write one, get it approved, change it, roll it back.
- Human approvals: approvers, signing, and what an approval covers.
- Connect your systems: built in connectors and external connectors.
- Verify and audit: records you can check without trusting the server.
- Deploy and operate: production, keys, migrations, monitoring.
- Errors and troubleshooting: what each answer means and what to do.
- Security model and limits: what is guaranteed, and what is not.
Versions
This edition describes the code onmain as of 2026-10-01. The published SDKs are 1.4.0 (@parmana/sdk on npm,
parmana on PyPI). Methods marked next release are in the repository and not yet published:
policyInEffect and policy_in_effect, verifyParmanaRelease and verify_parmana_release.