@boopkit/cli 0.6.11 → 0.6.13
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 +26 -5
- package/dist/capability-catalog.json +11 -0
- package/dist/capability-versions.json +2 -1
- package/dist/cli.js +2 -1
- package/dist/commands/add.js +49 -2
- package/dist/commands/init.d.ts +17 -1
- package/dist/commands/init.js +149 -25
- package/dist/commands/loop-merge.d.ts +1 -0
- package/dist/commands/loop-merge.js +4 -2
- package/dist/commands/loop.d.ts +21 -2
- package/dist/commands/loop.js +105 -16
- package/dist/commands/loop.js.orig-pre-maxbuffer +1455 -0
- package/dist/lib/execute.js +1 -1
- package/dist/lib/scaffold.d.ts +26 -9
- package/dist/lib/scaffold.js +60 -18
- package/docs/init.md +132 -86
- package/docs/loop.md +16 -0
- package/package.json +3 -2
- package/profiles/base/profile.md +105 -0
- package/profiles/base/templates/.github/copilot-instructions.md +3 -0
- package/profiles/base/templates/.gitignore.hbs +6 -0
- package/profiles/base/templates/AGENTS.md.hbs +50 -0
- package/profiles/base/templates/CLAUDE.md.hbs +3 -0
- package/profiles/base/templates/README.md.hbs +15 -0
- package/profiles/base/templates/docs/README.md +12 -0
- package/profiles/base/templates/package.json.hbs +7 -0
- package/profiles/base/templates/reference/README.md +16 -0
- package/profiles/base/templates/specs/README.md +12 -0
- package/profiles/development/profile.md +8 -1
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# {{projectName}}
|
|
2
|
+
|
|
3
|
+
This is a **boop**-managed project. Use boop commands — don't reinvent what boop already provides.
|
|
4
|
+
|
|
5
|
+
## Conversational style
|
|
6
|
+
When the user asks a question, it is for informational purpose and not a veiled request for action. Unless the user says a colloquially phrased command like "can you write a test for X" or "can you add a database", you should not take any action. If the user wants you to do something, they will ask you to do it directly.
|
|
7
|
+
|
|
8
|
+
Don't confirm a hypothesis (or take action) without observation - logs, tests, and other data are your friends. If you don't have the information you need to answer a question, find it (eg. run db queries, look at logs, add more logging, etc.) or ask for it instead of guessing.
|
|
9
|
+
|
|
10
|
+
## What this project is for
|
|
11
|
+
|
|
12
|
+
This project produces decisions, documents and tracked work rather than an application.
|
|
13
|
+
There is no code to build, test or deploy,
|
|
14
|
+
so don't set up a test suite, a build step or a feature branch unless you are asked to.
|
|
15
|
+
|
|
16
|
+
## How to work in this project
|
|
17
|
+
|
|
18
|
+
1. **Prefer project skills over general knowledge.**
|
|
19
|
+
When a skill matches your task — writing a spec, planning work, filing issues, documenting something, writing a proposal — follow its `SKILL.md` instead of working from memory.
|
|
20
|
+
Skills live in `skills/` (each is a folder with a `SKILL.md`) and are also exposed at `.claude/skills/` for tooling that auto-discovers there.
|
|
21
|
+
If your tooling does not auto-surface skills, list `skills/` and read each `SKILL.md`'s frontmatter (`name`, `description`) to find a match.
|
|
22
|
+
2. **Track work in beads.**
|
|
23
|
+
Every piece of work that outlives the current conversation is an issue in `bd`, not a markdown to-do list.
|
|
24
|
+
Run `bd ready` to see what is unblocked, and `bd create` to file something new.
|
|
25
|
+
3. **Check project status.**
|
|
26
|
+
Run `boop status` to see which capabilities are installed and whether anything needs attention.
|
|
27
|
+
4. **Use boop for capabilities.**
|
|
28
|
+
Run `boop caps` to see what is available.
|
|
29
|
+
If the project grows code of its own — infrastructure as code, a script worth keeping — run `boop add <capability>` (for example `boop add coding`) rather than installing and wiring things by hand.
|
|
30
|
+
5. **Run `boop --help`** for the full command list.
|
|
31
|
+
|
|
32
|
+
## Project layout
|
|
33
|
+
- `specs/` — what we intend: proposals, designs and plans ("future state")
|
|
34
|
+
- `reference/` — what exists now, kept true as things are finished or change ("current state")
|
|
35
|
+
- `docs/` — guides for the people who use what this project produces
|
|
36
|
+
- `skills/` — process skills for agents (each skill is a folder with a `SKILL.md`); also linked from `.claude/skills/` for Claude Code's built-in skill discovery
|
|
37
|
+
- `.beads/` — the issue tracker's database (managed by `bd`)
|
|
38
|
+
- `.boop/` — project manifest (managed by boop)
|
|
39
|
+
|
|
40
|
+
## The working cycle
|
|
41
|
+
|
|
42
|
+
1. **A spec describes the intent.**
|
|
43
|
+
Before a significant piece of work starts, write down in `specs/` what is wanted and why.
|
|
44
|
+
2. **Issues carry the work.**
|
|
45
|
+
Once the spec is agreed, break it into issues in beads, one per step someone can pick up and finish.
|
|
46
|
+
3. **`reference/` records the result.**
|
|
47
|
+
When a step is finished, or something that already exists changes, update `reference/` so it describes what is true now.
|
|
48
|
+
|
|
49
|
+
Specs stay as the record of what was intended.
|
|
50
|
+
`reference/` is what a newcomer reads to learn how things actually are, so it has to be kept current.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# {{projectName}}
|
|
2
|
+
|
|
3
|
+
A project scaffolded with [boop](https://github.com/boop),
|
|
4
|
+
for planning, writing and tracking work rather than building an application.
|
|
5
|
+
|
|
6
|
+
## How it is organized
|
|
7
|
+
|
|
8
|
+
- `specs/` — what we intend: proposals, designs and plans
|
|
9
|
+
- `reference/` — what exists now, kept true as things change
|
|
10
|
+
- `docs/` — guides for the people who use what this project produces
|
|
11
|
+
- `skills/` — the process skills agents follow when working here
|
|
12
|
+
- `.beads/` — the issue tracker; run `bd ready` to see what is next
|
|
13
|
+
|
|
14
|
+
`AGENTS.md` explains how an agent should work in this project,
|
|
15
|
+
and `boop status` shows which capabilities are installed.
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Docs
|
|
2
|
+
|
|
3
|
+
Guides for the people who **use** what this project produces.
|
|
4
|
+
Where `reference/` explains how things are set up for the people who maintain them, `docs/` explains how to use them.
|
|
5
|
+
|
|
6
|
+
## What belongs here
|
|
7
|
+
|
|
8
|
+
- How-to guides for a task someone will come here to do, written from their side
|
|
9
|
+
- Getting-started pages for someone meeting the result for the first time
|
|
10
|
+
- Answers to the questions people keep asking
|
|
11
|
+
|
|
12
|
+
Write for a reader who was not involved in the work and only needs to use its result.
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# Reference
|
|
2
|
+
|
|
3
|
+
Documents that describe **what exists now** — the current state of whatever this project has set up, decided or produced.
|
|
4
|
+
Where `specs/` records what we intend, `reference/` records what is actually true.
|
|
5
|
+
|
|
6
|
+
## What belongs here
|
|
7
|
+
|
|
8
|
+
- A description of each thing that exists: what it is, where it lives, how it is configured, and why it is that way
|
|
9
|
+
- Decisions that are in force, with enough of the reasoning that someone can tell when a decision no longer applies
|
|
10
|
+
- Conventions this project follows, so a newcomer can work the same way
|
|
11
|
+
|
|
12
|
+
## Keeping it true
|
|
13
|
+
|
|
14
|
+
A reference page is only useful while it matches reality.
|
|
15
|
+
When a piece of work is finished, or something that already exists changes, update the page that describes it as part of the same piece of work.
|
|
16
|
+
If a page no longer describes anything real, delete it rather than leaving it to mislead.
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Specs
|
|
2
|
+
|
|
3
|
+
Design documents and specifications for planned features and changes. Specs describe the **future state** — what we intend to build — in contrast to `reference/` which documents the **current state**.
|
|
4
|
+
|
|
5
|
+
## Workflow
|
|
6
|
+
|
|
7
|
+
1. Write a spec for a new feature or significant change
|
|
8
|
+
2. Review and approve the spec
|
|
9
|
+
3. Create implementation tasks (in beads) from the approved spec
|
|
10
|
+
4. After shipping, update `reference/` docs to reflect the new reality
|
|
11
|
+
|
|
12
|
+
Specs remain as a record of design intent even after implementation.
|
|
@@ -61,7 +61,14 @@ and it would make `boop init --profile development`
|
|
|
61
61
|
emit an Express `src/app.ts` that imports a dependency the profile never installs.
|
|
62
62
|
|
|
63
63
|
So `kernel` is absent, and `ProfileMetadata.kernel` is optional to allow it.
|
|
64
|
-
|
|
64
|
+
|
|
65
|
+
Having no kernel does not on its own stop `boop init`.
|
|
66
|
+
A profile that ships a `templates/` folder of its own, as `base` does,
|
|
67
|
+
is scaffolded from those templates instead.
|
|
68
|
+
This profile ships none, because it describes how a project is developed,
|
|
69
|
+
not what files the project starts with.
|
|
70
|
+
With neither a kernel nor templates there is nothing to write,
|
|
71
|
+
and the consequence is deliberate: `boop init --profile development` is refused
|
|
65
72
|
with a message pointing at the two ways this profile is actually meant to be used —
|
|
66
73
|
name it in an existing project's `.boop/config.json`,
|
|
67
74
|
or `boop add` these capabilities one at a time.
|