shipcraft 2.24.0 → 2.25.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.
Files changed (2) hide show
  1. package/README.md +3 -3
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -54,12 +54,12 @@ Every refusal is three lines: **what happened, why it matters, and the next step
54
54
 
55
55
  ## Quick start
56
56
 
57
- Installing is two steps: add the package (or the binary), then run `shipcraft init` in the project. Until `init` runs, nothing checks your commits.
57
+ Installing is two steps, and step 2 is required: add the package (or the binary), then run `init` at the repository root. `init` sets up Shipcraft and wires its hooks; until it runs, Shipcraft checks none of your commits. From the npm package, step 2 is `pnpm exec shipcraft init` or `npx -- shipcraft init`.
58
58
 
59
59
  ```bash
60
60
  # A Node/TypeScript project (macOS): pin Shipcraft in the project, like any dev dependency
61
61
  pnpm add -D shipcraft # step 1, or: npm i -D shipcraft
62
- pnpm exec shipcraft init # step 2, or: npx -- shipcraft init; the hooks call this project's install
62
+ pnpm exec shipcraft init # step 2 (required), or: npx -- shipcraft init; the hooks call this project's install
63
63
 
64
64
  # macOS (Apple silicon or Intel), any language: the latest release, checksum-verified, into ~/.local/bin
65
65
  gh repo clone victorassisalves/shipcraft && bash shipcraft/install.sh
@@ -199,7 +199,7 @@ Agents don't need a plugin, an MCP server or a skill. They find Shipcraft the sa
199
199
  - `git commit` runs the hook, and refusals say exactly what to do next;
200
200
  - `shipcraft init` writes a short block in `AGENTS.md` that tells agents the cycle: write the failing test and stub, run `shipcraft red`, commit the tests with the lock, then implement. In our trials (four runs per arm, a small sample) the earlier block took agents from 0/4 to 4/4 running `shipcraft red` before the first commit.
201
201
  - Since 2.17, the block also asks for the RED and the GREEN in separate sessions (a subagent per phase in Claude Code, a new `codex exec` per phase in Codex), and `init` adds an import of it to `CLAUDE.md` when Claude Code is installed or the file exists, since Claude Code reads `CLAUDE.md`. `init` upgrades a block it wrote earlier and keeps one you edited; while `AGENTS.md` holds an edited or older block, `CLAUDE.md` is left alone and `init` says so.
202
- - `shipcraft --version` and `shipcraft --help` say when the repository has no `.shipcraft.toml` yet, so an agent that checks the install is told to run `init`.
202
+ - `shipcraft --version` and `shipcraft --help` say when the repository has no `.shipcraft.toml` yet: one line names `init` as the required next step, with the one command to run (`pnpm exec shipcraft init`, `npx -- shipcraft init` or `shipcraft init`, by how Shipcraft is installed).
203
203
 
204
204
  Give the RED and the GREEN to different sessions. They can be the same model; separate context is what matters.
205
205
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "shipcraft",
3
- "version": "2.24.0",
3
+ "version": "2.25.0",
4
4
  "description": "A seatbelt for test-driven development with coding agents: locks the tests at RED so GREEN cannot quietly undo them.",
5
5
  "license": "Apache-2.0",
6
6
  "repository": { "type": "git", "url": "git+https://github.com/victorassisalves/shipcraft.git" },
@@ -10,7 +10,7 @@
10
10
  "files": ["bin/shipcraft.js", "LICENSE", "README.md"],
11
11
  "engines": { "node": ">=18" },
12
12
  "optionalDependencies": {
13
- "shipcraft-darwin-arm64": "2.24.0",
14
- "shipcraft-darwin-x64": "2.24.0"
13
+ "shipcraft-darwin-arm64": "2.25.0",
14
+ "shipcraft-darwin-x64": "2.25.0"
15
15
  }
16
16
  }