receipts-cli 0.1.3 → 0.1.4

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.
Files changed (2) hide show
  1. package/README.md +29 -17
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,5 +1,7 @@
1
1
  # receipts
2
2
 
3
+ [![npm](https://img.shields.io/npm/v/receipts-cli)](https://www.npmjs.com/package/receipts-cli)
4
+
3
5
  **Agents need receipts.**
4
6
 
5
7
  Your AI coding agent just told you it fixed the bug. Did it?
@@ -74,11 +76,24 @@ ship as adapters.
74
76
 
75
77
  ## Install
76
78
 
77
- Two independent paths - use either or both.
79
+ Two halves - the **agent adapter** (your agent produces receipts) and the **PR enforcer**
80
+ (they get checked). Use either alone or both. Set up per repo, step by step:
81
+
82
+ **1. Add the plugin** - teaches your Claude Code agent the Seven Gates:
83
+ ```bash
84
+ claude plugin marketplace add shaheershoaib/receipts
85
+ claude plugin install receipts
86
+ ```
78
87
 
79
- **Enforce it at the PR (any agent):**
88
+ **2. Configure the repo** - detects your stack + deploy target, confirms, writes `receipts.config.json`:
89
+ ```bash
90
+ npx receipts-cli init
91
+ # or run the latest unreleased from source: npx github:shaheershoaib/receipts init
92
+ ```
93
+
94
+ **3. Enforce at the PR** - re-runs each fix-claim's receipt (RED on the base commit, GREEN on the fix). Add `.github/workflows/receipts.yml`:
80
95
  ```yaml
81
- # .github/workflows/receipts.yml (full template: enforcer/example-workflow.yml)
96
+ # full template: enforcer/example-workflow.yml
82
97
  on: pull_request
83
98
  jobs:
84
99
  receipts:
@@ -90,19 +105,6 @@ jobs:
90
105
  - uses: shaheershoaib/receipts/enforcer@main
91
106
  ```
92
107
 
93
- **Teach your agent to pass it (Claude Code):**
94
- ```bash
95
- claude plugin marketplace add shaheershoaib/receipts
96
- claude plugin install receipts
97
- ```
98
-
99
- **Configure it for your project (any stack, any platform):**
100
- ```bash
101
- npx receipts-cli init # detects your stack + deploy target, confirms, writes receipts.config.json
102
- # not published to npm yet? run it straight from the repo, no install:
103
- # npx github:shaheershoaib/receipts init
104
- ```
105
-
106
108
  It works across any repo because the gate *logic* ships generic and only the project
107
109
  *plumbing* (how to test, where it deploys, what marks a fix-claim) is detected per
108
110
  project. See [enforcer/GENERALIZATION.md](enforcer/GENERALIZATION.md) for how,
@@ -118,12 +120,22 @@ Built and working today:
118
120
  - the Seven Gates spec (`spec/SEVEN-GATES.md`)
119
121
  - the focused `seven-gates` agent skill + two Stop-hook backstops (the Claude Code adapter)
120
122
  - the `trajectory-kb` memory MCP
121
- - `receipts init` - detects stack + deploy target, confirms, writes `receipts.config.json`
123
+ - `receipts init` - detects stack + deploy target, confirms, writes `receipts.config.json`; published to npm as [`receipts-cli`](https://www.npmjs.com/package/receipts-cli) (`npx receipts-cli init`)
122
124
  - the **CI enforcer** (`enforcer/`) - the red->green re-verification at the PR, as a GitHub Action
123
125
 
124
126
  Next: `verify.live_drive` for symptoms a test can't express (drive the deployed app),
125
127
  and an `examples/` demo of a caught wrong-fix.
126
128
 
129
+ ## Releasing (maintainer)
130
+
131
+ `receipts-cli` is on npm. To cut a new version:
132
+
133
+ 1. Bump `version` in `package.json` (and `plugin/.claude-plugin/plugin.json` too if the plugin itself changed).
134
+ 2. If you edited `plugin/mcp/trajectory-kb/index.js`, rebuild the bundled MCP server: `cd plugin/mcp/trajectory-kb && npm run build`, then commit the regenerated `server.bundle.mjs`.
135
+ 3. `npm publish`.
136
+
137
+ npm requires an auth token to publish **even with no 2FA** on the account. One-time: create a **Granular Access Token** (npmjs.com -> Access Tokens) with **Packages and scopes = Read and write, "All packages"** (Organizations = No access; no org needed), then `npm config set //registry.npmjs.org/:_authToken=<TOKEN>`. (Classic "Automation" tokens also work where the account still offers them.)
138
+
127
139
  ## License
128
140
 
129
141
  MIT. (The verification discipline should be free and everywhere.)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "receipts-cli",
3
- "version": "0.1.3",
3
+ "version": "0.1.4",
4
4
  "description": "Verification gates for AI-written code - re-prove an agent's fix before you trust it.",
5
5
  "bin": {
6
6
  "receipts": "bin/receipts.js"