@stefanoginella/auto-bmad 0.1.27 → 0.2.1
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 +36 -14
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,12 +4,14 @@
|
|
|
4
4
|
|
|
5
5
|
Automated (and very opinionated) BMAD pipeline orchestration for Claude Code.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
Two pipeline suites — **BMM** (Business Model Method) and **GDS** (Game Dev Suite) — each with four sequential commands that drive the BMAD development lifecycle from planning through story delivery.
|
|
8
8
|
|
|
9
9
|
> 👀 The pipelines are quite long and token hungry (the story pipeline alone can run for more than 60 minutes). Some steps might seem redundant, but I am satisfied with the code quality and consistency I get out of this. I recommend having a Claude Code Max x5 or x20 subscription to not hit limits mid-run.
|
|
10
10
|
|
|
11
11
|
## 🚀 Commands
|
|
12
12
|
|
|
13
|
+
### BMM (Business Model Method)
|
|
14
|
+
|
|
13
15
|
| Command | Steps | Description |
|
|
14
16
|
|---------|-------|-------------|
|
|
15
17
|
| `/auto-bmad-plan` | 11 | Pre-implementation pipeline: product brief, PRD, validate, UX, architecture, test framework, test design, epics, readiness, project context, sprint planning |
|
|
@@ -17,29 +19,42 @@ Four sequential pipeline commands that drive the BMAD software development lifec
|
|
|
17
19
|
| `/auto-bmad-story` | 13 | Develop a story: create, validate, adversarial review, ATDD, develop, edge-case hunt, 3x code review, NFR, trace, automate, test review |
|
|
18
20
|
| `/auto-bmad-epic-end` | 3 | Close an epic: trace, retrospective, project context refresh |
|
|
19
21
|
|
|
22
|
+
### GDS (Game Dev Suite)
|
|
23
|
+
|
|
24
|
+
| Command | Steps | Description |
|
|
25
|
+
|---------|-------|-------------|
|
|
26
|
+
| `/auto-gds-plan` | 8 | Pre-implementation pipeline: game brief, GDD, narrative design, game architecture, test framework, game test design, project context, sprint planning |
|
|
27
|
+
| `/auto-gds-epic-start` | 1 | Start a new epic: epic-level game test design |
|
|
28
|
+
| `/auto-gds-story` | 11 | Develop a story: create, validate, adversarial review, develop, edge-case hunt, 3x code review, performance, test automate, test review |
|
|
29
|
+
| `/auto-gds-epic-end` | 2 | Close an epic: retrospective, project context refresh |
|
|
30
|
+
|
|
20
31
|
## 🗂 Artifacts
|
|
21
32
|
|
|
22
33
|
The pipelines produce the following key artifacts throughout the lifecycle:
|
|
23
34
|
|
|
24
35
|
| Pipeline | Artifacts |
|
|
25
36
|
|----------|-----------|
|
|
26
|
-
| **Plan** | Product brief, PRD, UX design, architecture doc, test framework, CI configuration, epics, test design, sprint plan |
|
|
27
|
-
| **Epic Start** | Retro action resolution log, green baseline report, story order plan |
|
|
28
|
-
| **Story** | Story file, ATDD specs, implementation code, code review report, security scan results, regression/E2E results, traceability entries |
|
|
29
|
-
| **Epic End** | Aggregated epic data, traceability gate report, retrospective, next epic preview |
|
|
37
|
+
| **BMM Plan** | Product brief, PRD, UX design, architecture doc, test framework, CI configuration, epics, test design, sprint plan |
|
|
38
|
+
| **BMM Epic Start** | Retro action resolution log, green baseline report, story order plan |
|
|
39
|
+
| **BMM Story** | Story file, ATDD specs, implementation code, code review report, security scan results, regression/E2E results, traceability entries |
|
|
40
|
+
| **BMM Epic End** | Aggregated epic data, traceability gate report, retrospective, next epic preview |
|
|
41
|
+
| **GDS Plan** | Game brief, GDD, narrative design, game architecture, test framework, game test design, sprint plan |
|
|
42
|
+
| **GDS Epic Start** | Epic-level game test design |
|
|
43
|
+
| **GDS Story** | Story file, implementation code, code review report, performance assessment, game test automation, test review |
|
|
44
|
+
| **GDS Epic End** | Retrospective, project context refresh |
|
|
30
45
|
|
|
31
46
|
## 🛠 Typical Workflow
|
|
32
47
|
|
|
33
|
-
|
|
48
|
+
The workflow is the same for both BMM and GDS — substitute commands as needed. Below shows the BMM variant; for GDS, replace `/auto-bmad-*` with `/auto-gds-*`. If you already have all the planning artifacts ready, you can skip the plan pipeline and go directly to step 4 or 5.
|
|
34
49
|
|
|
35
50
|
1. **Prepare a strong and comprehensive input** for the plan pipeline — it validates readiness and won't run with a simple `Create a todo app` prompt. I recommend going through a few `/bmad-brainstorming` and `/bmad-party-mode` sessions first to build up enough context. If the initial input isn't ready, the plan pipeline will tell you what to improve.
|
|
36
|
-
2. **Run `/auto-bmad-plan`** to kick off the initial planning pipeline for a new project or major initiative.
|
|
37
|
-
3. **Review the PRD, Architecture, UX design, Epics, and Test Plan
|
|
38
|
-
4. **For each new epic**, run `/auto-bmad-epic-start` to establish a baseline and plan the story order based on the epic's goals and dependencies.
|
|
39
|
-
5. **For each story within an epic**, run `/auto-bmad-story` to develop the story from creation through delivery
|
|
51
|
+
2. **Run `/auto-bmad-plan`** (BMM) or **`/auto-gds-plan`** (GDS) to kick off the initial planning pipeline for a new project or major initiative.
|
|
52
|
+
3. **Review the generated artifacts** — PRD/GDD, Architecture, UX/Narrative design, Epics, and Test Plan. Make sure they look good and adjust if necessary before moving on to implementation. You might want to go through a few iterations of `/bmad-party-mode` to refine the output, since it sets the foundation for the next steps.
|
|
53
|
+
4. **For each new epic**, run `/auto-bmad-epic-start` (BMM) or `/auto-gds-epic-start` (GDS) to establish a baseline and plan the story order based on the epic's goals and dependencies.
|
|
54
|
+
5. **For each story within an epic**, run `/auto-bmad-story` (BMM) or `/auto-gds-story` (GDS) to develop the story from creation through delivery.
|
|
40
55
|
6. **After each story**, review the report generated by the story pipeline and any other BMAD artifacts, perform some manual testing, and correct course if necessary.
|
|
41
|
-
7. **At the end of an epic**, run `/auto-bmad-epic-end`
|
|
42
|
-
8. **Review the outputs of each pipeline run**, check the generated artifacts, and make adjustments as needed. The pipelines are opinionated and automated, but they still require human judgment and iteration. Use `/bmad-bmm-correct-course` when big changes are needed.
|
|
56
|
+
7. **At the end of an epic**, run `/auto-bmad-epic-end` (BMM) or `/auto-gds-epic-end` (GDS) to close the epic, conduct a retrospective, and preview the next epic.
|
|
57
|
+
8. **Review the outputs of each pipeline run**, check the generated artifacts, and make adjustments as needed. The pipelines are opinionated and automated, but they still require human judgment and iteration. Use `/bmad-bmm-correct-course` (BMM) or `/bmad-gds-correct-course` (GDS) when big changes are needed.
|
|
43
58
|
|
|
44
59
|
> ℹ️ **Important**: This plugin won't automate a multi-story workflow or an entire epic. Some human orchestration and judgment is still required between pipeline runs.
|
|
45
60
|
|
|
@@ -76,11 +91,14 @@ The pipelines are based on the [BMAD Method](https://github.com/bmad-code-org/BM
|
|
|
76
91
|
|
|
77
92
|
#### Required BMAD Modules
|
|
78
93
|
|
|
79
|
-
- **TEA** — Test Engineering Architect. Provides test strategy, test design, and ATDD capabilities used
|
|
94
|
+
- **TEA** — Test Engineering Architect. Provides test strategy, test design, and ATDD capabilities used by the BMM pipelines.
|
|
95
|
+
- **GDS** — Game Dev Suite. Provides game design, game architecture, narrative design, and game testing capabilities used by the GDS pipelines.
|
|
96
|
+
|
|
97
|
+
> You only need the modules for the pipeline suite you're using. TEA for BMM, GDS for GDS.
|
|
80
98
|
|
|
81
99
|
#### Optional BMAD Modules
|
|
82
100
|
|
|
83
|
-
- **CIS** — Creative Intelligence Suite. Enhances UX design quality during the plan pipeline. Without it, UX steps use baseline prompts.
|
|
101
|
+
- **CIS** — Creative Intelligence Suite. Enhances UX design quality during the BMM plan pipeline. Without it, UX steps use baseline prompts.
|
|
84
102
|
|
|
85
103
|
### Optional (but recommended) Claude Code Plugins
|
|
86
104
|
|
|
@@ -99,9 +117,13 @@ From the [`anthropics/claude-plugins-official`](https://github.com/anthropics/cl
|
|
|
99
117
|
|
|
100
118
|
The pipelines expect BMAD configuration files in the project:
|
|
101
119
|
|
|
120
|
+
**For BMM pipelines:**
|
|
102
121
|
- `_bmad/bmm/config.yaml` — BMM configuration (output folders, artifact paths)
|
|
103
122
|
- `_bmad/tea/config.yaml` — TEA configuration (test artifact paths)
|
|
104
123
|
|
|
124
|
+
**For GDS pipelines:**
|
|
125
|
+
- `_bmad/gds/config.yaml` — GDS configuration (output folders, artifact paths)
|
|
126
|
+
|
|
105
127
|
These files are normally created by the BMAD CLI when initializing BMAD in a project. The pipelines rely on the standard structure and paths defined by these configs, so custom configurations may require pipeline adjustments.
|
|
106
128
|
|
|
107
129
|
## 🔐 Permissions
|