altimate-receipts 0.3.2 → 0.4.0

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/README.md CHANGED
@@ -18,9 +18,9 @@ read straight from the agent's own transcript, on your machine.
18
18
  npx altimate-receipts # Report Card for your most recent agent session
19
19
  ```
20
20
 
21
- > **Adding it to a repo's PRs?** `receipts init` scaffolds the CI check, or see
22
- > [`docs/onboarding-internal.md`](./docs/onboarding-internal.md) install, the pre-push
23
- > hook, and the one-block PR check.
21
+ > **Adding it to a repo's PRs?** `npx altimate-receipts init` one command, one PR,
22
+ > and receipts attach themselves from then on. Contributors install nothing. See
23
+ > [Add it to a repo](#add-it-to-a-repo-nothing-to-install).
24
24
 
25
25
  ```text
26
26
  ╔══════════════════════════════════════════════════════════════════════════╗
@@ -162,7 +162,10 @@ receipts stats # dogfooding scoreboard: how often it ran + what it ca
162
162
  receipts eval # flag-rate of the detectors over your real local sessions
163
163
  receipts badge [receipt] # shields.io endpoint JSON for a README/PR badge
164
164
  receipts sarif [receipt] # SARIF 2.1.0 for GitHub code-scanning (inline + Security tab)
165
- receipts init # scaffold the PR-check workflow into this repo (1-command adopt)
165
+ receipts prune # remove committed receipts for merged/deleted branches (--dry-run)
166
+ receipts init # 1-command adopt: PR-check workflow + the repo-committed agent hook
167
+ receipts install-hook # write the self-updating git pre-push hook into .git/hooks
168
+ receipts setup-local # add the self-gated hook to YOUR ~/.claude/settings.json
166
169
  receipts rederive <t> # reproduce the canonical receipt from a transcript
167
170
  receipts mcp # start the MCP server (stdio) for IDEs/agents
168
171
  receipts --no-color # plain text (also honors NO_COLOR)
@@ -198,45 +201,26 @@ wasn't hand-edited (`receipts verify --transcript`, [trust model](./docs/trust.m
198
201
  This is **opt-in** — the value is the Report Card; signing is there for when your
199
202
  org's compliance or settlement needs make it concrete.
200
203
 
201
- ## Configure it locally (one prompt)
204
+ ## Add it to a repo (nothing to install)
202
205
 
203
- Your repo already has the **Verified by Receipts** check, but Receipts is local-first — the
204
- receipt is generated from *your* agent's transcript and committed to the branch; CI can't make
205
- it. So each contributor configures it once. Paste this prompt into your coding agent (Claude
206
- Code) **from inside the repo**, and it will set up local generation and verify the whole flow
207
- end to end — including that the receipt actually posts on the PR:
206
+ **Repo owner, once:**
208
207
 
209
- ```text
210
- Set up and verify altimate-receipts in this repo, end to end.
211
-
212
- 1. Make the `receipts` CLI available. Try `receipts --version`. If missing, try
213
- `npx --yes altimate-receipts --version`. If that also fails (private / not on npm),
214
- clone + build it and use it via node:
215
- git clone --depth 1 https://github.com/AltimateAI/altimate-receipts /tmp/altimate-receipts
216
- (cd /tmp/altimate-receipts && npm ci && npm run build)
217
- Then treat `receipts` as `node /tmp/altimate-receipts/dist/cli.js` everywhere below.
218
-
219
- 2. Configure it locally so every future push auto-attaches my receipt: create a
220
- `.githooks/pre-push` hook that runs `receipts pr`, and if it changes `.receipts/`,
221
- `git add .receipts/` + commit, then asks me to push again. Make it executable and run
222
- `git config core.hooksPath .githooks`. (Never let the hook fail the push.)
223
-
224
- 3. Generate THIS branch's receipt now from my local Claude Code transcript:
225
- `receipts pr --base <this repo's default branch>` → writes `.receipts/<branch>.json`.
226
-
227
- 4. Verify it is authentic and re-derivable: `receipts verify .receipts/<branch>.json` must pass.
208
+ ```sh
209
+ npx altimate-receipts init
210
+ ```
228
211
 
229
- 5. Commit it: `git add .receipts/<branch>.json && git commit -m "chore: attach agent receipt"`.
212
+ Commit the files it writes, merge the PR — done. From then on, any Claude Code session
213
+ that pushes a branch attaches its receipt automatically, *before* the push, so it lands
214
+ on the PR with no extra step.
230
215
 
231
- 6. Confirm uploading works end to end: push the branch and open/refresh the PR, then check that
232
- the "Verified by Receipts" CI check runs AND a Receipts comment appears
233
- (`gh pr checks` and `gh pr view --comments`). Report back whether the receipt is showing on
234
- the PR, and paste the comment's headline line.
235
- ```
216
+ **Contributors install nothing.** The hook travels with `git clone` (Claude Code asks
217
+ once to approve it), the CLI is fetched by npx on demand, and publishing a new release
218
+ updates everyone automatically. Every path is best-effort a missing session or an
219
+ unreachable registry never blocks a push.
236
220
 
237
- If step 6 shows the check + comment, uploading works. If the comment is missing, the agent
238
- will report why (no receipt committed, workflow not present, or a permissions issue) — the same
239
- classification the fleet check (`script/dogfood-health.mjs`) uses.
221
+ Humans pushing from a terminal, other coding agents, or repos that won't commit
222
+ `.claude/` config: **[the onboarding guide](./docs/onboarding.md)** has a one-command
223
+ fallback for each.
240
224
 
241
225
  ## Dogfooding
242
226