agentic-proofkit 0.1.91
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/ADOPTION.md +464 -0
- package/LICENSE +21 -0
- package/NON_CLAIMS.md +197 -0
- package/README.md +265 -0
- package/dist/agentic-proofkit +35 -0
- package/dist/platform/darwin-arm64/agentic-proofkit +0 -0
- package/dist/platform/darwin-x64/agentic-proofkit +0 -0
- package/dist/platform/linux-arm64/agentic-proofkit +0 -0
- package/dist/platform/linux-x64/agentic-proofkit +0 -0
- package/docs/adoption-checklist-report-design.md +138 -0
- package/docs/adoption-workflow-agent-envelope-design.md +67 -0
- package/docs/adoption-workflow-authority-routes-design.md +76 -0
- package/docs/adoption-workflow-contract-envelope-design.md +87 -0
- package/docs/adoption-workflow-plan-design.md +97 -0
- package/docs/agent-guidance-envelope-design.md +550 -0
- package/docs/binding-partition-admission-design.md +127 -0
- package/docs/bootstrap-agent-envelope-design.md +97 -0
- package/docs/bootstrap-materialization-manifest-design.md +100 -0
- package/docs/branch-authority-report-design.md +121 -0
- package/docs/changed-path-set-agent-envelope-design.md +70 -0
- package/docs/completion-criteria-report-design.md +132 -0
- package/docs/custom-rule-boundary-design.md +56 -0
- package/docs/deployment-evidence-admission-design.md +80 -0
- package/docs/document-lifecycle-boundary-design.md +62 -0
- package/docs/json-report-cli-adapter-design.md +83 -0
- package/docs/migration-parity-admission-design.md +90 -0
- package/docs/migration-plan-design.md +73 -0
- package/docs/obligation-decision-agent-envelope-design.md +105 -0
- package/docs/obligation-decision-state-design.md +100 -0
- package/docs/package-runtime-dependency-admission-design.md +80 -0
- package/docs/producer-policy-self-proof-design.md +142 -0
- package/docs/project-structure-agent-envelope-design.md +121 -0
- package/docs/project-structure-scaffold-design.md +89 -0
- package/docs/proof-obligation-algebra-design.md +108 -0
- package/docs/proof-receipt-admission-design.md +108 -0
- package/docs/proofkit-contract-map.md +55 -0
- package/docs/receipt-currentness-scope-admission-design.md +103 -0
- package/docs/receipt-producer-admission-design.md +106 -0
- package/docs/receipt-trust-class-admission-design.md +113 -0
- package/docs/rendered-artifact-freshness-design.md +55 -0
- package/docs/requirement-browser-view-design.md +229 -0
- package/docs/requirement-proof-resolver-projection-design.md +97 -0
- package/docs/requirement-proof-source-set-design.md +72 -0
- package/docs/requirement-proof-view-design.md +138 -0
- package/docs/requirement-source-admission-design.md +66 -0
- package/docs/requirement-source-transition-design.md +66 -0
- package/docs/requirement-source-view-design.md +51 -0
- package/docs/scaffold-profile-plan-design.md +72 -0
- package/docs/secret-shaped-json-scan-design.md +60 -0
- package/docs/selective-evidence-obligation-decision-design.md +139 -0
- package/docs/selective-evidence-producer-admission-design.md +106 -0
- package/docs/selective-evidence-receipt-trust-class-design.md +100 -0
- package/docs/selective-gate-evidence-agent-envelope-design.md +100 -0
- package/docs/selective-gate-plan-agent-envelope-design.md +95 -0
- package/docs/selective-planner-edge-coverage-design.md +89 -0
- package/docs/spec-overview-claim-boundary-design.md +50 -0
- package/docs/spec-proof-bundle-admission-design.md +105 -0
- package/docs/specs/proofkit-consumer-infra-retirement/overview.md +44 -0
- package/docs/specs/proofkit-consumer-infra-retirement/requirements.v1.json +175 -0
- package/docs/specs/proofkit-package-boundary/overview.md +32 -0
- package/docs/specs/proofkit-package-boundary/requirements.v1.json +121 -0
- package/docs/specs/proofkit-receipt-authority/overview.md +35 -0
- package/docs/specs/proofkit-receipt-authority/requirements.v1.json +121 -0
- package/docs/specs/proofkit-spec-proof-core/overview.md +36 -0
- package/docs/specs/proofkit-spec-proof-core/requirements.v1.json +148 -0
- package/docs/witness-scheduler-plan-design.md +57 -0
- package/docs/workspace-planning-agent-envelope-design.md +101 -0
- package/docs/workspace-registry-admission-design.md +57 -0
- package/package.json +54 -0
- package/proofkit/cli-contract.v1.json +808 -0
- package/proofkit/receipt-producer-policy.json +48 -0
- package/proofkit/requirement-bindings.json +520 -0
- package/proofkit/witness-plan.json +649 -0
package/NON_CLAIMS.md
ADDED
|
@@ -0,0 +1,197 @@
|
|
|
1
|
+
# Non-Claims
|
|
2
|
+
|
|
3
|
+
`proofkit` owns reusable proof infrastructure primitives
|
|
4
|
+
only.
|
|
5
|
+
|
|
6
|
+
It does not own:
|
|
7
|
+
|
|
8
|
+
- product requirements or product readiness;
|
|
9
|
+
- consuming repository requirement meaning, final proof-binding content,
|
|
10
|
+
command registry content, environment policy, native witness selection, or
|
|
11
|
+
merge admission decisions;
|
|
12
|
+
- consuming repository topology, work ledgers, or rollout policy;
|
|
13
|
+
- native witness execution or command pass evidence;
|
|
14
|
+
- GitHub App behavior, issue or pull-request automation, deployment, queues,
|
|
15
|
+
databases, LLM harnesses, or credentialed runtime behavior;
|
|
16
|
+
- organization rollout approval, consumer migration approval, consumer fallback
|
|
17
|
+
deletion, or consumer CI policy;
|
|
18
|
+
- packed-tarball pilot adoption as a registry release, organization rollout
|
|
19
|
+
approval, proof freshness decision, or native witness pass claim.
|
|
20
|
+
- package artifact verification as runtime execution proof for every non-native
|
|
21
|
+
embedded platform binary unless the CI matrix supplies that native OS and CPU
|
|
22
|
+
tuple.
|
|
23
|
+
- release-authority reports as package publication, registry credential
|
|
24
|
+
authority, package access-control proof, or consumer fallback-deletion
|
|
25
|
+
approval.
|
|
26
|
+
- GitHub Release tarballs, checksum files, or release manifests as the primary
|
|
27
|
+
dependency authority for package-manager consumers; public npm registry
|
|
28
|
+
identity remains the install authority.
|
|
29
|
+
- OCI, Homebrew, Go module, or GitHub Packages publication as completed release
|
|
30
|
+
channels unless their own release workflow and artifact identity are present.
|
|
31
|
+
- workspace package graph primitives as consuming repository script policy,
|
|
32
|
+
namespace policy, lockfile freshness proof, or CI admission authority.
|
|
33
|
+
- workspace changed-package and shard-partition CLI reports as git diff
|
|
34
|
+
discovery, repository scanning, CI scheduling policy, command execution,
|
|
35
|
+
dependency graph freshness, merge approval, rollout approval, or consumer
|
|
36
|
+
policy authority.
|
|
37
|
+
- repo-profile structural admission and command admission as repository-state
|
|
38
|
+
discovery, consuming repository command execution, shell-command authoring,
|
|
39
|
+
environment vocabulary authority, native witness pass evidence, or
|
|
40
|
+
replacement for caller-owned profile review.
|
|
41
|
+
- repo-profile scaffold plans as repository-state discovery, file writes,
|
|
42
|
+
overwrite safety, final repository profile content, profile admission,
|
|
43
|
+
command policy authority, native witness execution, proof freshness, merge
|
|
44
|
+
approval, rollout approval, or replacement for caller-owned profile review.
|
|
45
|
+
- project-structure scaffold reports or materialization manifests as
|
|
46
|
+
repository-state discovery, file writes, file existence proof, overwrite
|
|
47
|
+
safety, final module specification content, final repository profile content,
|
|
48
|
+
native witness execution, command pass evidence, receipt authenticity, proof
|
|
49
|
+
freshness, merge approval, enforcement promotion approval, release approval,
|
|
50
|
+
rollout approval, or consumer policy authority.
|
|
51
|
+
- project-structure scaffold agent envelopes as starter payload transport,
|
|
52
|
+
repository-state discovery, file writes, file existence proof, overwrite
|
|
53
|
+
safety, final specification or profile content, native witness execution,
|
|
54
|
+
command pass evidence, receipt authenticity, proof freshness, merge approval,
|
|
55
|
+
enforcement promotion approval, release approval, rollout approval, or
|
|
56
|
+
consumer policy authority.
|
|
57
|
+
- adoption-workflow-plan reports as repository-state discovery, file writes,
|
|
58
|
+
native witness execution, command pass evidence, receipt authenticity,
|
|
59
|
+
receipt freshness, CI freshness, merge approval, enforcement promotion
|
|
60
|
+
approval, rollout approval, scenario appropriateness, or consumer policy
|
|
61
|
+
authority.
|
|
62
|
+
- adoption-workflow-plan contract envelopes as primitive input payload
|
|
63
|
+
transport, scenario inference, repository-state discovery, file writes,
|
|
64
|
+
native witness execution, receipt authenticity, freshness, merge approval,
|
|
65
|
+
release approval, rollout approval, or consumer policy authority.
|
|
66
|
+
- adoption-workflow-plan agent envelopes as primitive input payload transport,
|
|
67
|
+
repository-state discovery, file writes, native witness execution, command
|
|
68
|
+
pass evidence, receipt authenticity, receipt freshness, CI freshness,
|
|
69
|
+
scenario selection, merge approval, enforcement promotion approval, release
|
|
70
|
+
approval, rollout approval, or consumer policy authority.
|
|
71
|
+
- adoption-checklist reports as repository-state discovery, native witness
|
|
72
|
+
execution, command pass evidence, evidence authentication, receipt freshness,
|
|
73
|
+
requiredness policy, merge approval, release approval, rollout approval,
|
|
74
|
+
production readiness, or consumer policy authority.
|
|
75
|
+
- completion-criteria reports as validator execution, native proof execution,
|
|
76
|
+
command pass evidence, evidence authentication, receipt freshness,
|
|
77
|
+
requirement meaning, proof adequacy, merge approval, release approval,
|
|
78
|
+
rollout approval, production readiness, or consumer policy authority.
|
|
79
|
+
- registry-consumer reports as package fetching, registry credential access,
|
|
80
|
+
native install execution, rollback execution proof, package access-control
|
|
81
|
+
proof, consumer migration approval, or proof freshness.
|
|
82
|
+
- package-runtime-dependency admission reports as package resolution, manifest
|
|
83
|
+
reads, lockfile reads, package-manager semantic proof, registry
|
|
84
|
+
authentication, dependency freshness, command execution, merge approval, or
|
|
85
|
+
consumer package policy authority.
|
|
86
|
+
- gradual-adoption-guidance reports as native witness execution, proof
|
|
87
|
+
freshness, autofix safety proof, waiver, readiness, rollout approval, or
|
|
88
|
+
consumer policy authority.
|
|
89
|
+
- agent guidance envelopes as native witness execution, proof freshness,
|
|
90
|
+
source report authenticity, edit approval, rollout approval, consumer policy
|
|
91
|
+
authority, LLM invocation, repository-state discovery, or replacement for
|
|
92
|
+
caller-owned review.
|
|
93
|
+
- rendered HTML, rendered Markdown, lookup graphs, slices, envelopes, or
|
|
94
|
+
validation reports as canonical repository source unless a consuming repository
|
|
95
|
+
explicitly admits a small tracked artifact with freshness checks.
|
|
96
|
+
- branch-authority reports as repository settings discovery, workflow parsing,
|
|
97
|
+
GitHub API access, branch mutation, branch protection proof, CI execution,
|
|
98
|
+
publish execution, package publication, release approval, rollout approval,
|
|
99
|
+
or consumer branch policy authority.
|
|
100
|
+
- gradual-adoption-bootstrap reports as file writes, native witness execution,
|
|
101
|
+
implicit repository-state scans, proof truth, rollout approval, or consumer CI
|
|
102
|
+
policy authority.
|
|
103
|
+
- gradual-adoption-bootstrap agent envelopes as file writes, starter payload
|
|
104
|
+
transport, native witness execution, command pass evidence, receipt
|
|
105
|
+
freshness, enforcement promotion approval, rollout approval, or consumer
|
|
106
|
+
policy authority.
|
|
107
|
+
- gradual-adoption-bootstrap materialization manifests as file writes, file
|
|
108
|
+
existence proof, overwrite safety, final specification or profile content,
|
|
109
|
+
native witness execution, command pass evidence, merge approval, enforcement
|
|
110
|
+
promotion approval, rollout approval, or consumer policy authority.
|
|
111
|
+
- migration plans as file edits, old proof-owner deletion, parity evidence
|
|
112
|
+
authentication, native witness execution, command pass evidence, proof
|
|
113
|
+
freshness, merge approval, rollout approval, retirement approval, or consumer
|
|
114
|
+
policy authority.
|
|
115
|
+
- bootstrap proof binding payloads as native witness execution, proof coverage,
|
|
116
|
+
proof freshness, caller repository approval, or a replacement for
|
|
117
|
+
caller-owned proof binding review.
|
|
118
|
+
- stack preset reports as consuming repository topology, mandatory CI policy,
|
|
119
|
+
proof coverage, native witness execution, rollout approval, or replacement
|
|
120
|
+
for caller-owned repository profiles.
|
|
121
|
+
- requirement-binding reports, evidence graphs, or proof slices as product
|
|
122
|
+
requirement meaning, native witness execution, command pass evidence, proof
|
|
123
|
+
freshness, waiver authority, rollout approval, or replacement for
|
|
124
|
+
caller-owned proof binding review.
|
|
125
|
+
- requirement-source admission reports as product requirement meaning, overview
|
|
126
|
+
Markdown citation linting, proof-binding adequacy, native witness execution,
|
|
127
|
+
receipt freshness, merge approval, rollout approval, or replacement for
|
|
128
|
+
caller-owned source review.
|
|
129
|
+
- requirement-source transition reports as diff discovery, product requirement
|
|
130
|
+
meaning, replacement semantic equivalence, native witness execution, receipt
|
|
131
|
+
freshness, deletion approval, merge approval, rollout approval, or
|
|
132
|
+
replacement for caller-owned source review.
|
|
133
|
+
- spec-overview claim boundary reports as Markdown reading, extractor
|
|
134
|
+
completeness, product requirement meaning, semantic adequacy of a cited
|
|
135
|
+
`REQ-*`, requirement source validation, merge approval, rollout approval, or
|
|
136
|
+
replacement for caller-owned overview review.
|
|
137
|
+
- requirement-source views as canonical source authority, requirement meaning,
|
|
138
|
+
overview Markdown linting, proof-binding adequacy, native witness execution,
|
|
139
|
+
receipt freshness, merge approval, rollout approval, or generated artifact
|
|
140
|
+
freshness.
|
|
141
|
+
- requirement-proof view models, Markdown rendering, or HTML rendering as
|
|
142
|
+
product requirement meaning, native witness execution, command pass evidence,
|
|
143
|
+
receipt freshness, producer authentication, generated artifact freshness,
|
|
144
|
+
merge approval, rollout approval, or canonical repository source.
|
|
145
|
+
- witness-scheduler-plan reports as native witness execution, filesystem
|
|
146
|
+
inspection, network inspection, lock-state inspection, cache-state
|
|
147
|
+
inspection, producer authentication, proof freshness, CI runner allocation,
|
|
148
|
+
merge approval, rollout approval, or proof-result cache authority.
|
|
149
|
+
- custom-rule-boundary reports as custom-rule execution, repository-state
|
|
150
|
+
discovery, generic Proofkit failure suppression, generic decision-state
|
|
151
|
+
downgrade, product requirement meaning, proof freshness, merge approval,
|
|
152
|
+
rollout approval, or promotion of a local rule into generic Proofkit
|
|
153
|
+
behavior.
|
|
154
|
+
- document-lifecycle-boundary reports as Markdown parsing, document content
|
|
155
|
+
review, product semantics, generated artifact freshness, route inference,
|
|
156
|
+
file archive or deletion approval, merge approval, rollout approval, or
|
|
157
|
+
replacement for caller-owned documentation review.
|
|
158
|
+
- rendered-artifact-freshness reports as source-file reads, rendered artifact
|
|
159
|
+
reads, renderer execution, requirement meaning, proof-route ownership, native
|
|
160
|
+
witness execution, publication approval, merge approval, rollout approval, or
|
|
161
|
+
replacement for caller-owned digest-producing witnesses.
|
|
162
|
+
- `agentActionPlan` entries as native witness execution, edit approval,
|
|
163
|
+
rollout approval, proof truth, consumer policy authority, or a replacement for
|
|
164
|
+
caller-owned review.
|
|
165
|
+
- selective-gate-plan reports as git state discovery, changed-path completeness
|
|
166
|
+
proof, native command execution, command pass evidence, generated artifact
|
|
167
|
+
freshness proof, proof coverage approval, secret-scan pass evidence, consumer
|
|
168
|
+
CI policy authority, or permission to skip caller-owned gates.
|
|
169
|
+
- selective-gate-evidence reports as native command execution, CI log
|
|
170
|
+
authority, receipt authenticity proof, receipt freshness proof, proof
|
|
171
|
+
coverage approval, consumer CI policy authority, or permission to skip
|
|
172
|
+
caller-owned gates. When optional producer admission is supplied, the report
|
|
173
|
+
validates metadata consistency only; it still does not authenticate
|
|
174
|
+
producers, prove freshness, or approve merge.
|
|
175
|
+
- receipt-producer-admission reports as producer authentication, CI trust-root
|
|
176
|
+
ownership, receipt freshness proof, command execution proof, command result
|
|
177
|
+
correctness, merge approval, rollout approval, or consumer policy authority.
|
|
178
|
+
- spec-proof-bundle admission reports as native witness execution, producer
|
|
179
|
+
authentication, receipt freshness, semantic proof adequacy, command result
|
|
180
|
+
correctness, merge approval, release approval, rollout approval, or
|
|
181
|
+
production readiness.
|
|
182
|
+
- readiness-closeout reports as product row-id authority, product phrase
|
|
183
|
+
authority, work-ledger ownership, readiness policy, native witness execution,
|
|
184
|
+
proof freshness, rollout approval, or production readiness.
|
|
185
|
+
|
|
186
|
+
Consuming repositories must keep their own specifications, proof bindings,
|
|
187
|
+
native witnesses, CI gates, and rollback policy.
|
|
188
|
+
|
|
189
|
+
Reference infrastructure boundary:
|
|
190
|
+
|
|
191
|
+
```text
|
|
192
|
+
Proofkit owns reusable grammar, algorithms, reports, rendering/view-model
|
|
193
|
+
machinery, selective planning, impact routing, receipt validation, and agent
|
|
194
|
+
guidance when those capabilities are generic.
|
|
195
|
+
Consuming repositories provide the requirement sentences, policies, witnesses,
|
|
196
|
+
receipts, and rollout decisions.
|
|
197
|
+
```
|
package/README.md
ADDED
|
@@ -0,0 +1,265 @@
|
|
|
1
|
+
# agentic-proofkit
|
|
2
|
+
|
|
3
|
+
Reusable CLI and JSON proof infrastructure for spec-to-proof workflows in
|
|
4
|
+
software repositories.
|
|
5
|
+
|
|
6
|
+
`agentic-proofkit` helps repositories build deterministic proof reports, validate
|
|
7
|
+
structured proof inputs, plan witness commands, model proof graphs, and report
|
|
8
|
+
changed-requirement impact without copying verifier logic between projects.
|
|
9
|
+
|
|
10
|
+
## Reference Infrastructure Role
|
|
11
|
+
|
|
12
|
+
Proofkit is the reference implementation boundary for the reusable
|
|
13
|
+
infrastructure side of spec-first machine-proof architecture. It is the package
|
|
14
|
+
where generic grammar, algorithms, deterministic reports, rendering/view-model
|
|
15
|
+
machinery, selective-planning primitives, receipt validation, and agent guidance
|
|
16
|
+
primitives belong when they do not encode consumer-specific truth. The
|
|
17
|
+
capabilities below list the currently implemented slices that consuming
|
|
18
|
+
repositories can use through one CLI dependency.
|
|
19
|
+
|
|
20
|
+
The package does not own the consuming repository's product semantics. A
|
|
21
|
+
consumer keeps its own specifications, requirement records, proof bindings,
|
|
22
|
+
command registry, environment policy, native witnesses, CI policy, and rollout
|
|
23
|
+
decisions. Proofkit validates, normalizes, renders, and plans from caller-owned
|
|
24
|
+
inputs.
|
|
25
|
+
|
|
26
|
+
Formal boundary:
|
|
27
|
+
|
|
28
|
+
```text
|
|
29
|
+
Proofkit owns generic grammar, algorithms, reports, and rendering machinery.
|
|
30
|
+
The repository provides the sentences, policies, witnesses, and decisions.
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Capability Routing
|
|
34
|
+
|
|
35
|
+
Proofkit capabilities are grouped into reusable primitive families. The package
|
|
36
|
+
README intentionally names the major groups only; the maintained routing table
|
|
37
|
+
for CLI commands, caller-owned inputs, Proofkit-owned mechanics, consumer-owned
|
|
38
|
+
policy, output authority, and non-claims is
|
|
39
|
+
[`docs/proofkit-contract-map.md`](docs/proofkit-contract-map.md).
|
|
40
|
+
|
|
41
|
+
Current groups:
|
|
42
|
+
|
|
43
|
+
- deterministic report grammar, schema admission, stable JSON, JSON report CLI
|
|
44
|
+
adapter mechanics, and redacted diagnostics;
|
|
45
|
+
- reusable profile, path, JSON, and secret-shaped JSON safety primitives;
|
|
46
|
+
- structured witness commands, scheduler metadata, and cache/concurrency safety
|
|
47
|
+
reports;
|
|
48
|
+
- requirement-source, spec-overview, requirement-proof, proof-graph, proof-slice,
|
|
49
|
+
compact-proof, and rendered-view primitives;
|
|
50
|
+
- changed-path, impact, selective planning, selective evidence, and obligation
|
|
51
|
+
decision projections;
|
|
52
|
+
- receipt admission, receipt producer admission, receipt currentness/scope,
|
|
53
|
+
receipt trust-class, producer-policy self-proof reports, and spec-proof
|
|
54
|
+
bundle admission;
|
|
55
|
+
- document lifecycle, rendered artifact freshness, custom-rule boundary,
|
|
56
|
+
deployment evidence admission, completion criteria, branch authority, release
|
|
57
|
+
authority, registry consumer, and external consumer reports;
|
|
58
|
+
- adoption workflow, adoption checklist, gradual adoption, stack presets,
|
|
59
|
+
profile scaffolding, project-structure scaffolding, migration planning,
|
|
60
|
+
migration parity admission, and agent guidance envelopes;
|
|
61
|
+
- workspace package graph, workspace registry, TypeScript package public API
|
|
62
|
+
surface, package dist manifest, shard partition, and repo-profile admission
|
|
63
|
+
helpers.
|
|
64
|
+
|
|
65
|
+
Every group follows the same boundary: Proofkit normalizes caller-owned inputs
|
|
66
|
+
and emits deterministic reports or views; it does not infer repository policy,
|
|
67
|
+
execute native witnesses, authenticate producers, compute proof freshness,
|
|
68
|
+
decide merge admission, or own consumer policy. Helpers whose names read, list,
|
|
69
|
+
or resolve files operate only on explicit caller-provided roots and paths; they
|
|
70
|
+
extract repository facts for consumer-owned scripts instead of owning freshness,
|
|
71
|
+
coverage, or gate policy.
|
|
72
|
+
|
|
73
|
+
## Primary Contract
|
|
74
|
+
|
|
75
|
+
The primary cross-language contract is the `agentic-proofkit` CLI plus
|
|
76
|
+
structured JSON inputs, deterministic JSON outputs, exit codes, and shipped
|
|
77
|
+
contract records. This is the contract Python, Go, Rust, Java, shell,
|
|
78
|
+
JavaScript, TypeScript, and CI consumers should target.
|
|
79
|
+
|
|
80
|
+
There is no package-root language SDK in the Go-only package model. Consumers
|
|
81
|
+
that want language-native ergonomics should wrap the CLI/JSON contract without
|
|
82
|
+
creating independent behavior, schema, freshness, or policy authority.
|
|
83
|
+
|
|
84
|
+
## CLI
|
|
85
|
+
|
|
86
|
+
The `agentic-proofkit` CLI reads caller-provided JSON. Report and planner commands emit
|
|
87
|
+
deterministic JSON; presentation commands emit Markdown or HTML only when an
|
|
88
|
+
explicit presentation format is requested:
|
|
89
|
+
|
|
90
|
+
The machine-readable CLI contract is `proofkit/cli-contract.v1.json`. It is the
|
|
91
|
+
compact command inventory for command ids, admitted flags, input modes, and
|
|
92
|
+
output modes; the examples below are human routing help, not the contract owner.
|
|
93
|
+
There is no second SDK-to-CLI parity owner.
|
|
94
|
+
|
|
95
|
+
```bash
|
|
96
|
+
# Inspect the complete machine contract when routing an agent or CI wrapper.
|
|
97
|
+
agentic-proofkit --help
|
|
98
|
+
|
|
99
|
+
# Start or migrate a repository into the spec/proof model.
|
|
100
|
+
agentic-proofkit adoption-workflow-plan --input proofkit/adoption-workflow-plan.json
|
|
101
|
+
agentic-proofkit adoption-workflow-plan --input proofkit/adoption-workflow-plan.json --agent-envelope
|
|
102
|
+
agentic-proofkit gradual-adoption-bootstrap --input proofkit/bootstrap.json
|
|
103
|
+
agentic-proofkit gradual-adoption-guidance --input proofkit/adoption-guidance.json
|
|
104
|
+
agentic-proofkit migration-parity-admission --input proofkit/migration-parity-admission.json
|
|
105
|
+
agentic-proofkit migration-plan --input proofkit/migration-plan.json
|
|
106
|
+
|
|
107
|
+
# Bind stable requirements to proof routes and selective gates.
|
|
108
|
+
agentic-proofkit obligation-decision --input proofkit/obligation-decision.json
|
|
109
|
+
agentic-proofkit requirement-bindings --input proofkit/requirement-bindings.json
|
|
110
|
+
agentic-proofkit requirement-proof-resolver --input proofkit/compact-requirement-bindings.json --local-environment-class local-go
|
|
111
|
+
agentic-proofkit selective-gate-plan --input proofkit/selective-gate-plan.json --agent-envelope
|
|
112
|
+
agentic-proofkit selective-gate-evidence --input proofkit/selective-gate-evidence.json
|
|
113
|
+
|
|
114
|
+
# Render source/proof views without making generated views authoritative.
|
|
115
|
+
agentic-proofkit requirement-browser-server --input proofkit/requirements.v1.json --view source --serve
|
|
116
|
+
agentic-proofkit requirement-browser-server --input proofkit/requirement-bindings.json --view proof --scope graph --serve --open
|
|
117
|
+
agentic-proofkit requirement-source-view --input proofkit/requirements.v1.json --format markdown
|
|
118
|
+
agentic-proofkit requirement-source-view --input proofkit/requirements.v1.json --format html > /tmp/proofkit-requirements.html
|
|
119
|
+
|
|
120
|
+
# Validate release, package, and evidence boundaries from caller-owned facts.
|
|
121
|
+
agentic-proofkit proof-receipt-admission --input proofkit/proof-receipts.json
|
|
122
|
+
agentic-proofkit producer-policy-self-proof --input proofkit/producer-policy-self-proof.json
|
|
123
|
+
agentic-proofkit release-authority --input proofkit/release-authority.json
|
|
124
|
+
agentic-proofkit registry-consumer --input proofkit/registry-consumer.json
|
|
125
|
+
agentic-proofkit receipt-trust-class --input proofkit/receipt-trust-class.json
|
|
126
|
+
|
|
127
|
+
# Author repository profiles without hardcoding a stack into Proofkit.
|
|
128
|
+
agentic-proofkit repo-profile-admission --input proofkit/repo-profile-admission.json
|
|
129
|
+
agentic-proofkit scaffold-profile-plan --input proofkit/scaffold-profile-plan.json
|
|
130
|
+
agentic-proofkit scaffold-project-structure --input proofkit/project-structure-scaffold.json
|
|
131
|
+
agentic-proofkit stack-preset --preset typescript_workspace
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
Use `--input -` to read the same JSON contract from stdin when a consumer
|
|
135
|
+
already has the input in memory and does not need a temporary file.
|
|
136
|
+
|
|
137
|
+
Use `--input-pointer <pointer>` to run a command against a JSON Pointer inside
|
|
138
|
+
the input document when the caller owns a larger envelope.
|
|
139
|
+
|
|
140
|
+
Supported mode flags:
|
|
141
|
+
|
|
142
|
+
- `--contract-envelope` is supported by `adoption-workflow-plan`,
|
|
143
|
+
`gradual-adoption`, `gradual-adoption-bootstrap`,
|
|
144
|
+
`gradual-adoption-guidance`, and `pilot-admission`.
|
|
145
|
+
- `pilot-admission` supports `--stack-diverse` and
|
|
146
|
+
`--pilot <first|stack-diverse|all>`; `--pilot all` requires
|
|
147
|
+
`--contract-envelope`.
|
|
148
|
+
- `gradual-adoption-guidance --contract-envelope` may narrow caller-owned
|
|
149
|
+
guidance with `--guidance-mode`, `--checked-scope`, and
|
|
150
|
+
`--touched-rule-id`.
|
|
151
|
+
- `conformance-profile` requires exactly one of `--verify`, `--list`, or
|
|
152
|
+
`--profile <id>` and supports `--format markdown` for selected profiles.
|
|
153
|
+
- `requirement-proof-resolver` and compact `requirement-proof-view` require
|
|
154
|
+
explicit local environment policy:
|
|
155
|
+
repeatable `--local-environment-class` flags or
|
|
156
|
+
`--empty-local-environment-policy`. Those flags are caller-owned policy used
|
|
157
|
+
only to project which requirements are preconditioned; Proofkit does not
|
|
158
|
+
decide environment policy.
|
|
159
|
+
|
|
160
|
+
`requirement-source-view --format html` and `requirement-proof-view --format
|
|
161
|
+
html` emit self-contained browser documents with hierarchy sections, local
|
|
162
|
+
search, field filters, card/table presentation modes, ID and detail visibility
|
|
163
|
+
toggles, and scenario/witness detail disclosure when proof inputs include those
|
|
164
|
+
facts. These HTML documents are rendered projections over structured source
|
|
165
|
+
records; they are not canonical source, do not execute witnesses, and should be
|
|
166
|
+
generated on demand unless a consumer repository adds its own rendered-artifact
|
|
167
|
+
freshness gate.
|
|
168
|
+
|
|
169
|
+
`requirement-browser-server` serves the same HTML views on a loopback-only local
|
|
170
|
+
HTTP endpoint. It is for review ergonomics: the server accepts explicit input,
|
|
171
|
+
rejects non-loopback hosts, exposes `/healthz`, and does not scan repositories,
|
|
172
|
+
execute witnesses, persist annotations, or decide freshness. Use it when a
|
|
173
|
+
developer wants to inspect requirement hierarchy, owner grouping, table/card
|
|
174
|
+
views, and linked proof scenarios in a browser without committing generated
|
|
175
|
+
HTML.
|
|
176
|
+
|
|
177
|
+
The CLI never executes native witnesses or caller-provided commands, reads
|
|
178
|
+
implicit repository state, publishes artifacts, or decides proof freshness.
|
|
179
|
+
Contract-envelope flags project caller-owned repository contracts into the
|
|
180
|
+
smallest Proofkit input accepted by that command. `registry-consumer` is
|
|
181
|
+
different: its CLI consumes a full registry-consumer report input because the
|
|
182
|
+
report also requires caller-collected proof evidence. Consumers that need a
|
|
183
|
+
repo-specific projection into registry-consumer input should keep that
|
|
184
|
+
projection in their own repository and feed the resulting JSON to the CLI.
|
|
185
|
+
Use `selective-gate-obligation-decision-input` as a pure translation step, then
|
|
186
|
+
pipe it into the existing obligation decision owner when a report or agent
|
|
187
|
+
envelope is needed:
|
|
188
|
+
|
|
189
|
+
```bash
|
|
190
|
+
agentic-proofkit selective-gate-obligation-decision-input --input proofkit/selective-gate-obligation-decision.json \
|
|
191
|
+
| agentic-proofkit obligation-decision --input -
|
|
192
|
+
|
|
193
|
+
agentic-proofkit selective-gate-obligation-decision-input --input proofkit/selective-gate-obligation-decision.json \
|
|
194
|
+
| agentic-proofkit obligation-decision --input - --agent-envelope
|
|
195
|
+
```
|
|
196
|
+
`--agent-envelope` is an opt-in output projection for supported reports. It
|
|
197
|
+
changes the shape of the emitted JSON into an agent-facing work packet, but it
|
|
198
|
+
does not change command execution, proof freshness, edit approval, rollout
|
|
199
|
+
approval, or repository policy authority. Agent envelopes include a cost
|
|
200
|
+
contract with emitted ref counts, omitted-edge accounting, stop reason,
|
|
201
|
+
sufficiency basis, and escalation route so bounded guidance cannot silently
|
|
202
|
+
become a broad proof-graph prompt.
|
|
203
|
+
|
|
204
|
+
## Package Boundary
|
|
205
|
+
|
|
206
|
+
The public npm release is one root CLI package. The `agentic-proofkit` package
|
|
207
|
+
contains the POSIX launcher, embedded statically linked Go binaries for each
|
|
208
|
+
supported OS/CPU tuple, package metadata, `README.md`, `ADOPTION.md`,
|
|
209
|
+
`NON_CLAIMS.md`, proofkit contract records, the proofkit contract map, specs,
|
|
210
|
+
and stable design notes for shipped primitives. Consumers declare only the root
|
|
211
|
+
`agentic-proofkit` dependency.
|
|
212
|
+
|
|
213
|
+
Package verification smokes the installed launcher on the current runner
|
|
214
|
+
platform and verifies the root tarball contains every embedded platform binary;
|
|
215
|
+
it does not execute every cross-compiled architecture binary unless CI supplies
|
|
216
|
+
that native tuple. Source files, tests, generated JavaScript, type declaration
|
|
217
|
+
artifacts, source maps, implementation planning records, and build-cache files
|
|
218
|
+
are not package artifacts.
|
|
219
|
+
|
|
220
|
+
This repository targets public npm as the primary dependency channel and
|
|
221
|
+
GitHub Releases as the immutable archive/provenance channel. `npm pack`, the
|
|
222
|
+
package artifact test, publish dry-run evidence, post-publish registry capture,
|
|
223
|
+
checksums, and the release manifest together prove tarball shape,
|
|
224
|
+
external-consumer behavior, declared artifact identity, and channel boundaries.
|
|
225
|
+
A consumer may treat a versioned registry package as the default dependency
|
|
226
|
+
only after an actual package publication, exact install proof, parity proof,
|
|
227
|
+
and rollback path are recorded by that consumer.
|
|
228
|
+
|
|
229
|
+
Registry releases must distinguish local or dry-run artifact identity from the
|
|
230
|
+
artifact identity served by the package registry after publish. The publish
|
|
231
|
+
workflow captures post-publish package metadata with the package name, version,
|
|
232
|
+
filename, shasum, and integrity. Registry-consumer evidence should reference
|
|
233
|
+
that published registry identity, because it describes the artifact the
|
|
234
|
+
registry serves. Consumer repositories still own whether and how exact registry
|
|
235
|
+
identity becomes merge policy.
|
|
236
|
+
|
|
237
|
+
Formal rule:
|
|
238
|
+
|
|
239
|
+
```text
|
|
240
|
+
Dry-run artifacts prove package shape before publish.
|
|
241
|
+
Published registry artifacts prove the bytes consumers install.
|
|
242
|
+
GitHub Release assets prove archive/provenance lookup, not dependency install authority.
|
|
243
|
+
Registry-consumer evidence references published registry identity.
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
See [ADOPTION.md](ADOPTION.md) for registry and tarball channel obligations.
|
|
247
|
+
See [Proofkit Contract Map](docs/proofkit-contract-map.md) for primitive
|
|
248
|
+
routing and [Agent Guidance Envelope Design](docs/agent-guidance-envelope-design.md)
|
|
249
|
+
for the reusable agent-facing guidance layer.
|
|
250
|
+
|
|
251
|
+
## Gates
|
|
252
|
+
|
|
253
|
+
```bash
|
|
254
|
+
npm run check
|
|
255
|
+
git diff --check
|
|
256
|
+
```
|
|
257
|
+
|
|
258
|
+
`npm run check` includes Go tests/static analysis, package artifact creation,
|
|
259
|
+
package artifact verification, outside-consumer binary smoke proof, and
|
|
260
|
+
self-hosting receipt generation. Publish dry-run evidence is owned by the
|
|
261
|
+
tag-only `release` workflow because it must run over the complete release
|
|
262
|
+
tarball.
|
|
263
|
+
|
|
264
|
+
See [NON_CLAIMS.md](NON_CLAIMS.md) for boundaries that remain owned by
|
|
265
|
+
consuming repositories.
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
#!/usr/bin/env sh
|
|
2
|
+
set -eu
|
|
3
|
+
|
|
4
|
+
case "$(uname -s)" in
|
|
5
|
+
Darwin) os="darwin" ;;
|
|
6
|
+
Linux) os="linux" ;;
|
|
7
|
+
*) echo "agentic-proofkit: unsupported operating system: $(uname -s)" >&2; exit 1 ;;
|
|
8
|
+
esac
|
|
9
|
+
|
|
10
|
+
case "$(uname -m)" in
|
|
11
|
+
x86_64|amd64) arch="x64" ;;
|
|
12
|
+
arm64|aarch64) arch="arm64" ;;
|
|
13
|
+
*) echo "agentic-proofkit: unsupported architecture: $(uname -m)" >&2; exit 1 ;;
|
|
14
|
+
esac
|
|
15
|
+
|
|
16
|
+
script="$0"
|
|
17
|
+
while [ -L "$script" ]; do
|
|
18
|
+
link=$(readlink "$script")
|
|
19
|
+
case "$link" in
|
|
20
|
+
/*) script="$link" ;;
|
|
21
|
+
*) script=$(CDPATH= cd -- "$(dirname -- "$script")" && pwd)/"$link" ;;
|
|
22
|
+
esac
|
|
23
|
+
done
|
|
24
|
+
|
|
25
|
+
dir=$(CDPATH= cd -- "$(dirname -- "$script")" && pwd)
|
|
26
|
+
package_dir=$(CDPATH= cd -- "$dir/.." && pwd)
|
|
27
|
+
binary="$package_dir/dist/platform/$os-$arch/agentic-proofkit"
|
|
28
|
+
|
|
29
|
+
if [ ! -x "$binary" ]; then
|
|
30
|
+
echo "agentic-proofkit: missing embedded platform binary for $os-$arch" >&2
|
|
31
|
+
echo "agentic-proofkit: reinstall agentic-proofkit from the published package artifact" >&2
|
|
32
|
+
exit 1
|
|
33
|
+
fi
|
|
34
|
+
|
|
35
|
+
exec "$binary" "$@"
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
# Adoption Checklist Report Design
|
|
2
|
+
|
|
3
|
+
## Decision
|
|
4
|
+
|
|
5
|
+
Proofkit provides an `adoption-checklist` report that classifies
|
|
6
|
+
caller-provided adoption evidence into satisfied, missing, blocked, and
|
|
7
|
+
not-applicable checklist items for a selected adoption scenario.
|
|
8
|
+
|
|
9
|
+
## Problem
|
|
10
|
+
|
|
11
|
+
Proofkit now offers workflow plans, scaffolds, materialization manifests,
|
|
12
|
+
agent envelopes, selective plans, receipt producer checks, release authority,
|
|
13
|
+
and consumer checks. A consuming repository still needs a compact way to answer:
|
|
14
|
+
|
|
15
|
+
```text
|
|
16
|
+
Which proofkit adoption obligations are already evidenced?
|
|
17
|
+
Which required obligations are still missing or blocked?
|
|
18
|
+
Which commands or evidence refs should an agent inspect next?
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Without that report, agents must infer adoption state from README prose or
|
|
22
|
+
multiple primitive outputs. That repeats context loading and risks treating
|
|
23
|
+
optional or advisory evidence as merge-satisfying proof.
|
|
24
|
+
|
|
25
|
+
## Boundary
|
|
26
|
+
|
|
27
|
+
Proofkit owns:
|
|
28
|
+
|
|
29
|
+
- deterministic validation of caller-provided checklist item records;
|
|
30
|
+
- required-item coverage and state classification;
|
|
31
|
+
- sorted evidence refs, command refs, and blocker diagnostics;
|
|
32
|
+
- stable report output and non-claims.
|
|
33
|
+
|
|
34
|
+
The consuming repository owns:
|
|
35
|
+
|
|
36
|
+
- repository state discovery;
|
|
37
|
+
- whether an adoption item is required for its policy;
|
|
38
|
+
- evidence authenticity, freshness, and producer admission;
|
|
39
|
+
- native command execution and receipts;
|
|
40
|
+
- merge, enforcement, release, rollout, and production-readiness decisions.
|
|
41
|
+
|
|
42
|
+
Formal rule:
|
|
43
|
+
|
|
44
|
+
```text
|
|
45
|
+
The checklist report classifies caller-provided evidence.
|
|
46
|
+
It does not discover, execute, authenticate, or approve that evidence.
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Required item ids are caller-policy input. Proofkit validates that every
|
|
50
|
+
required id references a declared item and then applies the generic state table
|
|
51
|
+
below; it does not decide which items a repository must require.
|
|
52
|
+
|
|
53
|
+
## Model
|
|
54
|
+
|
|
55
|
+
The input declares:
|
|
56
|
+
|
|
57
|
+
- `scenario`;
|
|
58
|
+
- sorted checklist items;
|
|
59
|
+
- sorted required item ids;
|
|
60
|
+
- optional follow-up command refs;
|
|
61
|
+
- explicit non-claims.
|
|
62
|
+
|
|
63
|
+
Each item has:
|
|
64
|
+
|
|
65
|
+
- `itemId`;
|
|
66
|
+
- `status = satisfied | missing | blocked | not_applicable`;
|
|
67
|
+
- owner;
|
|
68
|
+
- evidence refs;
|
|
69
|
+
- command refs;
|
|
70
|
+
- optional blocker text;
|
|
71
|
+
- non-claims.
|
|
72
|
+
|
|
73
|
+
Evidence refs are opaque caller-owned references. They may name files,
|
|
74
|
+
artifacts, receipt ids, URLs, or hashes according to consumer policy, but
|
|
75
|
+
proofkit does not parse or dereference them as paths. A consumer that needs
|
|
76
|
+
path-only evidence must enforce that in its repository policy or a separate
|
|
77
|
+
profile command.
|
|
78
|
+
|
|
79
|
+
State table:
|
|
80
|
+
|
|
81
|
+
| Status | Required evidence | Blocker | Merge meaning |
|
|
82
|
+
|---|---|---|---|
|
|
83
|
+
| `satisfied` | Must have at least one evidence ref | Must be absent | May satisfy a required checklist item if caller policy made it required |
|
|
84
|
+
| `missing` | May be empty | Must be absent | Fails when required; advisory when optional |
|
|
85
|
+
| `blocked` | May be empty | Must be present | Fails when required; visible when optional |
|
|
86
|
+
| `not_applicable` | May be empty | Must be absent | Fails when required; advisory when optional |
|
|
87
|
+
|
|
88
|
+
Command refs are routing metadata only. They never count as evidence refs and
|
|
89
|
+
never prove native command execution or command pass evidence.
|
|
90
|
+
|
|
91
|
+
The report passes only when every required item is `satisfied`. Missing,
|
|
92
|
+
blocked, and not-applicable required items are failures. Optional items may be
|
|
93
|
+
missing or not-applicable without failing the report, but they remain visible in
|
|
94
|
+
the summary and diagnostics.
|
|
95
|
+
|
|
96
|
+
The `scenario` field reuses `ProofkitAdoptionWorkflowScenario` from adoption
|
|
97
|
+
workflow planning. The checklist report does not own a second scenario
|
|
98
|
+
vocabulary or scenario-routing policy.
|
|
99
|
+
|
|
100
|
+
## Rejected Alternatives
|
|
101
|
+
|
|
102
|
+
| Alternative | Rejection reason |
|
|
103
|
+
|---|---|
|
|
104
|
+
| Scan repository files to infer checklist state | Repository topology and file existence are consumer-owned facts. |
|
|
105
|
+
| Reuse adoption workflow plans | Workflow plans route commands; they do not classify already-collected evidence. |
|
|
106
|
+
| Reuse gradual adoption guidance | Guidance is module-scoped and source-report-scoped; adoption checklist state can span packaging, profile, bindings, witnesses, receipts, and release channel. |
|
|
107
|
+
| Treat checklist output as an agent work packet | Agent envelopes already own bounded work packets; checklist reports own compact state classification only. |
|
|
108
|
+
| Treat optional missing items as failures | Consumers need gradual adoption without pretending optional evidence is merge-blocking. |
|
|
109
|
+
|
|
110
|
+
## Proof Obligations
|
|
111
|
+
|
|
112
|
+
- Unit tests prove pass/fail classification, required-item coverage,
|
|
113
|
+
deterministic sorting, optional item non-failures, and malformed input
|
|
114
|
+
rejection.
|
|
115
|
+
- CLI tests prove stable JSON output, stdin parity, JSON pointer selection,
|
|
116
|
+
failed-checklist exit codes, and unsupported flag rejection.
|
|
117
|
+
- Package artifact tests prove the package binary, CLI smoke path, and design note
|
|
118
|
+
are shipped to outside consumers.
|
|
119
|
+
- Full package check proves existing adoption workflow, scaffold, and guidance
|
|
120
|
+
behavior remains unchanged.
|
|
121
|
+
|
|
122
|
+
## Non-Claims
|
|
123
|
+
|
|
124
|
+
Adoption checklist reports do not claim:
|
|
125
|
+
|
|
126
|
+
- repository-state discovery;
|
|
127
|
+
- file existence;
|
|
128
|
+
- evidence authenticity;
|
|
129
|
+
- evidence freshness;
|
|
130
|
+
- producer admission;
|
|
131
|
+
- native command execution;
|
|
132
|
+
- command pass evidence;
|
|
133
|
+
- merge approval;
|
|
134
|
+
- enforcement promotion approval;
|
|
135
|
+
- release approval;
|
|
136
|
+
- rollout approval;
|
|
137
|
+
- production readiness;
|
|
138
|
+
- consumer policy authority.
|