Skip to content
This repository was archived by the owner on Jul 10, 2026. It is now read-only.

Commit 3400a86

Browse files
authored
docs(README): document bootstrap --bundle/--dry-run (#161)
Role-scoped bootstrap bundles (backlog 130) shipped tonight with zero mention in README.md -- a cold operator following the Quick Start had no way to discover the feature exists, which was itself the blocker to the usage evidence 130's own notes say bundles need before they can become a default. Documented all 5 bundles with fresh live numbers from `bootstrap --bundle <name> --dry-run` rather than trusting a possibly-stale estimate: full catalog is 51 skills/~21.4k description bytes; bundles range 8-21 skills/~4.0-7.8k bytes. Cross-checked flag names against --help's actual usage line by hand, not just the gate. Closes-backlog: 138 Agent: overnight autonomous lane Agent-Surface: Claude Code Agent-Model: claude-sonnet-5
1 parent dab1218 commit 3400a86

3 files changed

Lines changed: 30 additions & 10 deletions

File tree

‎README.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,25 @@ is already on `PATH`. Bootstrap from a stable checkout (set
2929
`HARNESS_KIT_DIR=/path/to/harness-kit` to pin one), never a disposable
3030
worktree.
3131

32+
By default bootstrap installs the full skill catalog (51 skills, ~21.4k
33+
description bytes standing in every session's system prompt). Pass
34+
`--bundle NAME` for a role-scoped subset instead — same install, fewer
35+
skills:
36+
37+
```bash
38+
harness-kit-checks bootstrap --bundle lead # 11 skills, ~5.2k bytes
39+
harness-kit-checks bootstrap --bundle implementer # 12 skills, ~5.2k bytes
40+
harness-kit-checks bootstrap --bundle critic # 10 skills, ~4.2k bytes
41+
harness-kit-checks bootstrap --bundle designer # 21 skills, ~7.8k bytes
42+
harness-kit-checks bootstrap --bundle vault # 8 skills, ~4.0k bytes
43+
```
44+
45+
Add `--dry-run` to preview the projected skill count and byte estimate
46+
without touching the filesystem (works with or without `--bundle`).
47+
Bundles are opt-in — omitting `--bundle` keeps today's full-catalog
48+
behavior unchanged; membership is defined in `.harness-kit/bundles.yaml`
49+
(backlog 130).
50+
3251
## Skills
3352

3453
| Skill | Purpose |

backlog.d/138-document-bootstrap-bundle-flag.md renamed to backlog.d/_done/138-document-bootstrap-bundle-flag.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Document bootstrap --bundle/--dry-run in the README Quick Start
22

3-
Priority: P2 · Status: ready · Estimate: S
3+
Priority: P2 (shipped) · Status: done · Estimate: S · Shipped: 2026-07-02
44

55
## Goal
66

@@ -11,17 +11,22 @@ no way to discover the feature exists.
1111

1212
## Oracle
1313

14-
- [ ] `README.md`'s Quick Start section documents `--bundle NAME` and
14+
- [x] `README.md`'s Quick Start section documents `--bundle NAME` and
1515
`--dry-run` alongside the existing bootstrap one-liner, naming the
1616
available bundles (`lead`, `implementer`, `critic`, `designer`,
1717
`vault`) and the default (full catalog, unchanged) behavior when the
1818
flag is omitted.
19-
- [ ] The doc states the measured effect from 130's own oracle (full catalog
19+
- [x] The doc states the measured effect from 130's own oracle (full catalog
2020
~21.4k description bytes vs. ~4-8k per bundle) so the value proposition
21-
is legible without reading `bundles.yaml`.
22-
- [ ] `cargo run --locked -p harness-kit-checks -- bootstrap --help` output
21+
is legible without reading `bundles.yaml`. (Used fresh live numbers
22+
from `bootstrap --bundle <name> --dry-run` for all 5 bundles rather
23+
than trusting 130's possibly-stale estimate: full catalog is 51
24+
skills/~21471 bytes; bundles range 8–21 skills/~4.0–7.8k bytes today.)
25+
- [x] `cargo run --locked -p harness-kit-checks -- bootstrap --help` output
2326
and the README stay consistent (cross-check by hand, not just gate).
24-
- [ ] `cargo run --locked -p harness-kit-checks -- check --repo .` passes.
27+
(`--help`'s usage line reads `bootstrap [--repo PATH] [--bundle NAME]
28+
[--dry-run]` — README's flag names/casing match exactly.)
29+
- [x] `cargo run --locked -p harness-kit-checks -- check --repo .` passes.
2530

2631
## Notes
2732

‎docs/site/manifest.json‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,6 @@
5151
{
5252
"source": "backlog.d/132-greenfield-template-ci.md",
5353
"title": "Declare and verify the greenfield Factory template"
54-
},
55-
{
56-
"source": "backlog.d/138-document-bootstrap-bundle-flag.md",
57-
"title": "Document bootstrap --bundle/--dry-run in the README Quick Start"
5854
}
5955
],
6056
"copy_source": "docs/copy/site.json",

0 commit comments

Comments
 (0)