Skip to content

Commit 4dd84fd

Browse files
committed
docs: add required ssot-registry workflow guidance
1 parent 3a3dc20 commit 4dd84fd

1 file changed

Lines changed: 79 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,85 @@ Do:
4444
- update current-state docs when promotion-relevant truth changes
4545
- create a new versioned root when a promoted release needs correction
4646
- use `MUT.json` and `tools/govchk.py` before mutating unfamiliar folders
47+
- use the `ssot-registry` CLI as the canonical tracking plane for features, tests, claims, evidence, boundaries, and releases
48+
49+
## SSOT registry contract (required)
50+
51+
Agents are required to use the `ssot-registry` CLI command for planning and certification tracking work.
52+
53+
Reference command surface before use:
54+
55+
```bash
56+
ssot-registry -h
57+
```
58+
59+
Canonical artifact:
60+
61+
- `.ssot/registry.json` is the machine-readable source of truth
62+
- derived projections (reports/exports/graphs) must be treated as generated views
63+
64+
### Feature tracking
65+
66+
Use `feature` commands to create and maintain normalized feature records, lifecycle, and planning posture:
67+
68+
```bash
69+
ssot-registry feature create . --id feat:<name> --title "<title>"
70+
ssot-registry feature update . --id feat:<name> ...
71+
ssot-registry feature plan . --ids feat:<name> --horizon current --claim-tier T1
72+
ssot-registry feature link . --id feat:<name> --claim-ids clm:<name> --test-ids tst:<name>
73+
```
74+
75+
### Feature-testing tracking
76+
77+
Track test intent and status with explicit links back to features/claims/evidence:
78+
79+
```bash
80+
ssot-registry test create . --id tst:<name> --title "<title>" --kind <kind> --test-path <repo-path>
81+
ssot-registry test update . --id tst:<name> --status passing
82+
ssot-registry test link . --id tst:<name> --feature-ids feat:<name> --claim-ids clm:<name> --evidence-ids evd:<name>
83+
```
84+
85+
### Claims and evidence tracking
86+
87+
Claims must be linked to implementable features and verifiable tests/evidence:
88+
89+
```bash
90+
ssot-registry claim create . --id clm:<name> --title "<title>" --kind <kind> --tier T1
91+
ssot-registry claim evaluate .
92+
ssot-registry evidence create . --id evd:<name> --title "<title>" --kind <kind> --evidence-path <repo-path>
93+
ssot-registry evidence verify .
94+
```
95+
96+
### Boundary and release management
97+
98+
Freeze scope first, then certify/promote/publish releases against that frozen scope:
99+
100+
```bash
101+
ssot-registry boundary create . --id bnd:<name> --title "<title>" --feature-ids feat:<name>
102+
ssot-registry boundary freeze . --boundary-id bnd:<name>
103+
ssot-registry release create . --id rel:<version> --version <version> --boundary-id bnd:<name>
104+
ssot-registry release certify . --release-id rel:<version> --write-report
105+
ssot-registry release promote . --release-id rel:<version>
106+
ssot-registry release publish . --release-id rel:<version>
107+
```
108+
109+
### Validation and exports
110+
111+
Use registry validation and graph/export surfaces during review and release prep:
112+
113+
```bash
114+
ssot-registry validate . --write-report
115+
ssot-registry graph export . --format json --output .ssot/graphs/registry.graph.json
116+
ssot-registry registry export . --format toml --output .ssot/exports/registry.toml
117+
```
118+
119+
### PyPI package notes (current as of 2026-04-16)
120+
121+
- Package: `ssot-registry`
122+
- Latest PyPI version: `0.2.2`
123+
- Latest release upload: `2026-04-15T22:47:41Z`
124+
- Project page: `https://pypi.org/project/ssot-registry/`
125+
- Repository: `https://github.com/groupsum/ssot-registry`
47126

48127
## Boundary model
49128

0 commit comments

Comments
 (0)