bmad-method 6.0.1 → 6.0.2
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/.claude/skills/bmad-os-audit-file-refs/SKILL.md +6 -0
- package/.claude/skills/bmad-os-audit-file-refs/prompts/instructions.md +59 -0
- package/.claude/skills/bmad-os-changelog-social/SKILL.md +1 -2
- package/.claude/skills/bmad-os-diataxis-style-fix/SKILL.md +1 -2
- package/.claude/skills/bmad-os-draft-changelog/SKILL.md +1 -2
- package/.claude/skills/bmad-os-gh-triage/SKILL.md +1 -7
- package/.claude/skills/bmad-os-release-module/SKILL.md +1 -2
- package/.claude/skills/bmad-os-review-pr/SKILL.md +6 -0
- package/{tools/maintainer/review-pr.md → .claude/skills/bmad-os-review-pr/prompts/instructions.md} +5 -16
- package/.prettierignore +3 -0
- package/CHANGELOG.md +37 -0
- package/README.md +13 -1
- package/docs/how-to/customize-bmad.md +14 -14
- package/docs/how-to/established-projects.md +15 -3
- package/docs/how-to/get-answers-about-bmad.md +39 -8
- package/docs/how-to/install-bmad.md +13 -4
- package/docs/how-to/non-interactive-installation.md +1 -1
- package/docs/how-to/quick-fixes.md +1 -1
- package/docs/index.md +10 -4
- package/docs/reference/commands.md +21 -1
- package/docs/reference/workflow-map.md +29 -62
- package/docs/roadmap.mdx +136 -0
- package/docs/tutorials/getting-started.md +69 -15
- package/package.json +2 -2
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-01-init.md +2 -2
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-01b-continue.md +3 -3
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-02-vision.md +1 -1
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-03-users.md +1 -1
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-04-metrics.md +1 -1
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-05-scope.md +1 -1
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-06-complete.md +1 -1
- package/src/bmm/workflows/1-analysis/create-product-brief/workflow.md +1 -1
- package/src/bmm/workflows/1-analysis/research/domain-steps/step-01-init.md +2 -2
- package/src/bmm/workflows/1-analysis/research/domain-steps/step-02-domain-analysis.md +2 -2
- package/src/bmm/workflows/1-analysis/research/domain-steps/step-03-competitive-landscape.md +2 -2
- package/src/bmm/workflows/1-analysis/research/domain-steps/step-04-regulatory-focus.md +2 -2
- package/src/bmm/workflows/1-analysis/research/domain-steps/step-05-technical-trends.md +1 -1
- package/src/bmm/workflows/1-analysis/research/domain-steps/step-06-research-synthesis.md +2 -1
- package/src/bmm/workflows/1-analysis/research/market-steps/step-01-init.md +2 -2
- package/src/bmm/workflows/1-analysis/research/market-steps/step-02-customer-behavior.md +2 -2
- package/src/bmm/workflows/1-analysis/research/market-steps/step-03-customer-pain-points.md +2 -2
- package/src/bmm/workflows/1-analysis/research/market-steps/step-04-customer-decisions.md +2 -2
- package/src/bmm/workflows/1-analysis/research/market-steps/step-06-research-completion.md +2 -1
- package/src/bmm/workflows/1-analysis/research/technical-steps/step-01-init.md +2 -2
- package/src/bmm/workflows/1-analysis/research/technical-steps/step-02-technical-overview.md +2 -2
- package/src/bmm/workflows/1-analysis/research/technical-steps/step-03-integration-patterns.md +2 -2
- package/src/bmm/workflows/1-analysis/research/technical-steps/step-04-architectural-patterns.md +2 -2
- package/src/bmm/workflows/1-analysis/research/technical-steps/step-05-implementation-research.md +2 -2
- package/src/bmm/workflows/1-analysis/research/technical-steps/step-06-research-synthesis.md +2 -1
- package/src/bmm/workflows/1-analysis/research/workflow-domain-research.md +1 -1
- package/src/bmm/workflows/1-analysis/research/workflow-market-research.md +1 -1
- package/src/bmm/workflows/1-analysis/research/workflow-technical-research.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-01b-continue.md +2 -3
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02-discovery.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02b-vision.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02c-executive-summary.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-03-success.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-04-journeys.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-05-domain.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-06-innovation.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-07-project-type.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-08-scoping.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-09-functional.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-10-nonfunctional.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-11-polish.md +3 -3
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-12-complete.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-13-report-complete.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/workflow-create-prd.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/workflow-edit-prd.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-prd/workflow-validate-prd.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01-init.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01b-continue.md +3 -3
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-02-discovery.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-05-inspiration.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-06-design-system.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-07-defining-experience.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-08-visual-foundation.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-09-design-directions.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-10-user-journeys.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-11-component-strategy.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-12-ux-patterns.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-13-responsive-accessibility.md +2 -2
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md +1 -1
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md +2 -2
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md +1 -1
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md +2 -2
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-01-init.md +2 -2
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-01b-continue.md +11 -2
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-02-context.md +2 -2
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-03-starter.md +3 -5
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-04-decisions.md +2 -2
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-05-patterns.md +2 -2
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-06-structure.md +2 -2
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-07-validation.md +2 -2
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-08-complete.md +1 -1
- package/src/bmm/workflows/3-solutioning/create-architecture/workflow.md +3 -3
- package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md +1 -1
- package/src/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md +1 -1
- package/src/bmm/workflows/4-implementation/code-review/workflow.yaml +1 -2
- package/src/bmm/workflows/4-implementation/correct-course/workflow.yaml +1 -2
- package/src/bmm/workflows/4-implementation/create-story/checklist.md +2 -2
- package/src/bmm/workflows/4-implementation/create-story/workflow.yaml +1 -2
- package/src/bmm/workflows/4-implementation/dev-story/workflow.yaml +1 -2
- package/src/bmm/workflows/4-implementation/retrospective/workflow.yaml +1 -2
- package/src/bmm/workflows/4-implementation/sprint-planning/workflow.yaml +1 -1
- package/src/bmm/workflows/4-implementation/sprint-status/workflow.yaml +1 -1
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md +6 -6
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md +1 -1
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md +1 -1
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-04-self-check.md +1 -1
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md +1 -1
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md +2 -2
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-01-understand.md +4 -6
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-02-investigate.md +1 -2
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-03-generate.md +1 -2
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md +2 -2
- package/src/bmm/workflows/document-project/workflow.yaml +1 -1
- package/src/bmm/workflows/generate-project-context/steps/step-01-discover.md +1 -1
- package/src/bmm/workflows/generate-project-context/steps/step-02-generate.md +1 -1
- package/src/bmm/workflows/generate-project-context/workflow.md +2 -2
- package/src/bmm/workflows/{qa/automate → qa-generate-e2e-tests}/workflow.yaml +2 -4
- package/src/core/tasks/editorial-review-prose.xml +1 -1
- package/src/core/tasks/editorial-review-structure.xml +1 -2
- package/src/core/tasks/help.md +3 -2
- package/src/core/tasks/index-docs.xml +1 -1
- package/src/core/tasks/review-adversarial-general.xml +2 -1
- package/src/core/tasks/shard-doc.xml +1 -1
- package/src/core/workflows/advanced-elicitation/workflow.xml +1 -0
- package/src/core/workflows/brainstorming/workflow.md +1 -1
- package/src/core/workflows/party-mode/workflow.md +1 -1
- package/tools/cli/installers/lib/ide/_config-driven.js +0 -1
- package/tools/cli/installers/lib/ide/codex.js +195 -181
- package/tools/cli/installers/lib/ide/github-copilot.js +0 -1
- package/tools/cli/installers/lib/ide/manager.js +3 -3
- package/tools/cli/installers/lib/ide/platform-codes.yaml +11 -4
- package/tools/cli/installers/lib/ide/rovodev.js +257 -0
- package/tools/cli/installers/lib/ide/shared/task-tool-command-generator.js +0 -1
- package/tools/cli/installers/lib/ide/templates/agent-command-template.md +0 -1
- package/tools/cli/installers/lib/ide/templates/combined/default-agent.md +0 -1
- package/tools/cli/installers/lib/ide/templates/combined/default-workflow-yaml.md +0 -1
- package/tools/cli/installers/lib/ide/templates/combined/default-workflow.md +0 -1
- package/tools/cli/installers/lib/ide/templates/workflow-command-template.md +0 -1
- package/tools/cli/installers/lib/ide/templates/workflow-commander.md +0 -1
- package/tools/cli/lib/ui.js +1 -1
- package/tools/platform-codes.yaml +12 -12
- package/tools/validate-doc-links.js +20 -6
- package/website/astro.config.mjs +1 -0
- package/website/src/rehype-markdown-links.js +9 -1
- package/website/src/styles/custom.css +296 -0
- package/.claude/skills/bmad-os-gh-triage/README.md +0 -14
- package/.claude/skills/bmad-os-release-module/README.md +0 -24
- package/tools/maintainer/review-pr-README.md +0 -55
- /package/src/bmm/workflows/{qa/automate → qa-generate-e2e-tests}/checklist.md +0 -0
- /package/src/bmm/workflows/{qa/automate → qa-generate-e2e-tests}/instructions.md +0 -0
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: bmad-os-audit-file-refs
|
|
3
|
+
description: Audit BMAD source files for file-reference convention violations using parallel Haiku subagents. Use when users requests an "audit file references" for a skill, workflow or task.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Read `prompts/instructions.md` and execute.
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# audit-file-refs
|
|
2
|
+
|
|
3
|
+
Audit new-format BMAD source files for file-reference convention violations using parallel Haiku subagents.
|
|
4
|
+
|
|
5
|
+
## Convention
|
|
6
|
+
|
|
7
|
+
In new-format BMAD workflow and task files (`src/bmm/`, `src/core/`, `src/utility/`), every file path reference must use one of these **valid** forms:
|
|
8
|
+
|
|
9
|
+
- `{project-root}/_bmad/path/to/file.ext` — canonical form, always correct
|
|
10
|
+
- `{installed_path}/relative/path` — valid in new-format step files (always defined by workflow.md before any step is reached)
|
|
11
|
+
- Template/runtime variables: `{nextStepFile}`, `{workflowFile}`, `{{mustache}}`, `{output_folder}`, `{communication_language}`, etc. — skip these, they are substituted at runtime
|
|
12
|
+
|
|
13
|
+
**Flag any reference that uses:**
|
|
14
|
+
|
|
15
|
+
- `./step-NN.md` or `../something.md` — relative paths
|
|
16
|
+
- `step-NN.md` — bare filename with no path prefix
|
|
17
|
+
- `steps/step-NN.md` — bare steps-relative path (missing `{project-root}/_bmad/...` prefix)
|
|
18
|
+
- `` `_bmad/core/tasks/help.md` `` — bare `_bmad/` path (missing `{project-root}/`)
|
|
19
|
+
- `/Users/...`, `/home/...`, `C:\...` — absolute system paths
|
|
20
|
+
|
|
21
|
+
References inside fenced code blocks (``` ``` ```) are examples — skip them.
|
|
22
|
+
|
|
23
|
+
Old-format files in `src/bmm/workflows/4-implementation/` use `{installed_path}` by design within the XML calling chain — exclude that directory entirely.
|
|
24
|
+
|
|
25
|
+
## Steps
|
|
26
|
+
|
|
27
|
+
1. Run this command to get the file list:
|
|
28
|
+
```
|
|
29
|
+
find src/bmm src/core src/utility -type f \( -name "*.md" -o -name "*.yaml" \) | grep -v "4-implementation" | sort
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
2. Divide the resulting file paths into batches of roughly 20 files each.
|
|
33
|
+
|
|
34
|
+
3. For each batch, spawn a subagent (`subagent_type: "Explore"`, `model: "haiku"`) with this prompt (fill in the actual file paths):
|
|
35
|
+
|
|
36
|
+
> Read each of these files (use the Read tool on each):
|
|
37
|
+
> [list the file paths from this batch]
|
|
38
|
+
>
|
|
39
|
+
> For each file, identify every line that contains a file path reference that violates the convention described below. Skip references inside fenced code blocks. Skip template variables (anything containing `{` that isn't `{project-root}` or `{installed_path}`).
|
|
40
|
+
>
|
|
41
|
+
> **Valid references:** `{project-root}/_bmad/...`, `{installed_path}/...`, template variables.
|
|
42
|
+
> **Flag:** bare filenames (`step-NN.md`), `./` or `../` relative paths, bare `steps/` paths, bare `_bmad/` paths (without `{project-root}/`), absolute system paths.
|
|
43
|
+
>
|
|
44
|
+
> Return findings as a list:
|
|
45
|
+
> `path/to/file.md:LINE_NUMBER | VIOLATION_TYPE | offending text`
|
|
46
|
+
>
|
|
47
|
+
> If a file has no violations, include it as: `path/to/file.md | clean`
|
|
48
|
+
>
|
|
49
|
+
> End your response with a single line: `FILES CHECKED: N` where N is the exact number of files you read.
|
|
50
|
+
|
|
51
|
+
4. Collect all findings from all subagents.
|
|
52
|
+
|
|
53
|
+
5. **Self-check before reporting:** Count the total number of files returned by the `find` command. Sum the `FILES CHECKED: N` values across all subagent responses. If the totals do not match, identify which files are missing and re-run subagents for those files before proceeding. Do not produce the final report until all files are accounted for.
|
|
54
|
+
|
|
55
|
+
6. Output a final report:
|
|
56
|
+
- Group findings by violation type
|
|
57
|
+
- List each finding as `file:line — offending text`
|
|
58
|
+
- Show total count of violations and number of affected files
|
|
59
|
+
- If nothing found, say "All files conform to the convention."
|
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: bmad-os-changelog-social
|
|
3
|
-
description: Generate social media announcements for Discord, Twitter, and LinkedIn from the latest changelog entry. Use when user asks to create release
|
|
4
|
-
disable-model-invocation: true
|
|
3
|
+
description: Generate social media announcements for Discord, Twitter, and LinkedIn from the latest changelog entry. Use when user asks to 'create release announcement' or 'create social posts' or share changelog updates.
|
|
5
4
|
---
|
|
6
5
|
|
|
7
6
|
# Changelog Social
|
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: bmad-os-diataxis-style-fix
|
|
3
|
-
description: Fixes documentation to comply with Diataxis framework and BMad Method style guide rules
|
|
4
|
-
disable-model-invocation: true
|
|
3
|
+
description: Fixes documentation to comply with Diataxis framework and BMad Method style guide rules. Use when user asks to check or fix style of files under the docs folder.
|
|
5
4
|
---
|
|
6
5
|
|
|
7
6
|
Read `prompts/instructions.md` and execute.
|
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: bmad-os-draft-changelog
|
|
3
|
-
description: Analyzes changes since last release and updates CHANGELOG.md ONLY.
|
|
4
|
-
disable-model-invocation: true
|
|
3
|
+
description: "Analyzes changes since last release and updates CHANGELOG.md ONLY. Use when users requests 'update the changelog' or 'prepare changelog release notes'"
|
|
5
4
|
---
|
|
6
5
|
|
|
7
6
|
Read `prompts/instructions.md` and execute.
|
|
@@ -1,12 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: bmad-os-gh-triage
|
|
3
|
-
description:
|
|
4
|
-
license: MIT
|
|
5
|
-
disable-model-invocation: true
|
|
6
|
-
metadata:
|
|
7
|
-
author: bmad-code-org
|
|
8
|
-
version: "3.0.0"
|
|
9
|
-
compatibility: Requires gh CLI, git repository, and BMad Method with Task tool support
|
|
3
|
+
description: Analyze all github issues. Use when the user says 'triage the github issues' or 'analyze open github issues'.
|
|
10
4
|
---
|
|
11
5
|
|
|
12
6
|
Read `prompts/instructions.md` and execute.
|
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: bmad-os-release-module
|
|
3
|
-
description:
|
|
4
|
-
disable-model-invocation: true
|
|
3
|
+
description: Perform requested version bump, git tag, npm publish, GitHub release. Use when user requests 'perform a release' only.
|
|
5
4
|
---
|
|
6
5
|
|
|
7
6
|
Read `prompts/instructions.md` and execute.
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: bmad-os-review-pr
|
|
3
|
+
description: Adversarial PR review tool (Raven's Verdict). Cynical deep review transformed into professional engineering findings. Use when user asks to 'review a PR' and provides a PR url or id.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Read `prompts/instructions.md` and execute.
|
package/{tools/maintainer/review-pr.md → .claude/skills/bmad-os-review-pr/prompts/instructions.md}
RENAMED
|
@@ -2,8 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
A cynical adversarial review, transformed into cold engineering professionalism.
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
CRITICAL: Sandboxed Execution Rules
|
|
5
|
+
## CRITICAL: Sandboxed Execution Rules
|
|
7
6
|
|
|
8
7
|
Before proceeding, you MUST verify:
|
|
9
8
|
|
|
@@ -14,9 +13,6 @@ Before proceeding, you MUST verify:
|
|
|
14
13
|
|
|
15
14
|
**If no explicit PR number/URL was provided, STOP immediately and ask:**
|
|
16
15
|
"What PR number or URL should I review?"
|
|
17
|
-
</orientation>
|
|
18
|
-
|
|
19
|
-
<preflight-checks>
|
|
20
16
|
|
|
21
17
|
## Preflight Checks
|
|
22
18
|
|
|
@@ -97,9 +93,7 @@ gh pr diff {PR_NUMBER} [--repo {REPO}] --name-only | grep -E '\.(png|jpg|jpeg|gi
|
|
|
97
93
|
|
|
98
94
|
Store list of binary files to skip. Note them in final output.
|
|
99
95
|
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
<adversarial-review>
|
|
96
|
+
## Adversarial Review
|
|
103
97
|
|
|
104
98
|
### 1.1 Run Cynical Review
|
|
105
99
|
|
|
@@ -130,9 +124,7 @@ Likely tag:
|
|
|
130
124
|
- Add `[likely]` to findings with high confidence, e.g. with direct evidence
|
|
131
125
|
- Sort findings by severity (Critical → Moderate → Minor), not by confidence
|
|
132
126
|
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
<tone-transformation>
|
|
127
|
+
## Tone Transformation
|
|
136
128
|
|
|
137
129
|
**Transform the cynical output into cold engineering professionalism.**
|
|
138
130
|
|
|
@@ -177,9 +169,8 @@ Output format after transformation:
|
|
|
177
169
|
_Review generated by Raven's Verdict. LLM-produced analysis - findings may be incorrect or lack context. Verify before acting._
|
|
178
170
|
```
|
|
179
171
|
|
|
180
|
-
|
|
172
|
+
## Post Review
|
|
181
173
|
|
|
182
|
-
<post-review>
|
|
183
174
|
### 3.1 Preview
|
|
184
175
|
|
|
185
176
|
Display the complete transformed review to the user.
|
|
@@ -231,12 +222,10 @@ Do NOT use heredocs or `echo` - Markdown code blocks will break shell parsing. U
|
|
|
231
222
|
|
|
232
223
|
Keep the temp file and inform user of location.
|
|
233
224
|
|
|
234
|
-
|
|
225
|
+
## Notes
|
|
235
226
|
|
|
236
|
-
<notes>
|
|
237
227
|
- The "cynical asshole" phase is internal only - never posted
|
|
238
228
|
- Tone transform MUST happen before any external output
|
|
239
229
|
- When in doubt, ask the user - never assume
|
|
240
230
|
- If you're unsure about severity, err toward higher severity
|
|
241
231
|
- If you're unsure about confidence, be honest and use Medium or Low
|
|
242
|
-
</notes>
|
package/.prettierignore
CHANGED
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,42 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [6.0.2]
|
|
4
|
+
|
|
5
|
+
### 🎁 Features
|
|
6
|
+
|
|
7
|
+
* Add CodeBuddy platform support with installer configuration (#1483)
|
|
8
|
+
* Add LLM audit prompt for file reference conventions - new audit tool using parallel subagents (#1720)
|
|
9
|
+
* Migrate Codex installer from `.codex/prompts` to `.agents/skills` format to align with Codex CLI changes (#1729)
|
|
10
|
+
* Convert review-pr and audit-file-refs tools to proper bmad-os skills with slash commands `/bmad-os-review-pr` and `/bmad-os-audit-file-refs` (#1732)
|
|
11
|
+
|
|
12
|
+
### 🐛 Bug Fixes
|
|
13
|
+
|
|
14
|
+
* Fix 24 broken step references in create-architecture workflow after directory rename (#1734)
|
|
15
|
+
* Fix step file path references in check-implementation-readiness workflow (#1709, #1716)
|
|
16
|
+
* Fix 3 broken file references and enable strict file reference validation in CI (#1717)
|
|
17
|
+
* Fix Rovo Dev integration with custom installer that generates prompts.yml manifest (#1701)
|
|
18
|
+
* Fix 104 relative step file references to use standardized `{project-root}/_bmad/` paths across 68 files (#1722)
|
|
19
|
+
* Fix code fence imbalance in step-03-starter.md that caused rendering issues (#1724)
|
|
20
|
+
* Remove Windsurf from recommended/preferred IDEs list (#1727)
|
|
21
|
+
* Fix default Codex install location from global to project for better defaults (#1698)
|
|
22
|
+
* Add npx cache workaround to Quick Start for stale beta versions (#1685)
|
|
23
|
+
* Add language instructions to replace placeholder text in Research overview (#1703)
|
|
24
|
+
* Ignore `.junie/` IDE integration folder in git and prettier configs (#1719)
|
|
25
|
+
|
|
26
|
+
### ♻️ Refactoring
|
|
27
|
+
|
|
28
|
+
* Update open source tool skills structure for future plugin migration
|
|
29
|
+
* Standardize all workflow descriptions for skill generation with concise format and explicit trigger phrases
|
|
30
|
+
* Remove `disable-model-invocation` flag from all IDE installer templates to enable workflow skill calls
|
|
31
|
+
|
|
32
|
+
### 📚 Documentation
|
|
33
|
+
|
|
34
|
+
* Elevate `bmad-help` as primary on-ramp across all documentation
|
|
35
|
+
* Update workflow names with `bmad-bmm-` prefix and standardize table formatting
|
|
36
|
+
* Clarify phase routing and catalog path in help task
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
3
40
|
## [6.0.0]
|
|
4
41
|
|
|
5
42
|
V6 Stable Release! The End of Beta!
|
package/README.md
CHANGED
|
@@ -22,6 +22,16 @@ Traditional AI tools do the thinking for you, producing average results. BMad ag
|
|
|
22
22
|
|
|
23
23
|
[Learn more at **docs.bmad-method.org**](http://docs.bmad-method.org)
|
|
24
24
|
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
## 🚀 What's Next for BMad?
|
|
28
|
+
|
|
29
|
+
**V6 is here and we're just getting started!** The BMad Method is evolving rapidly with optimizations including Cross Platform Agent Team and Sub Agent inclusion, Skills Architecture, BMad Builder v1, Dev Loop Automation, and so much more in the works.
|
|
30
|
+
|
|
31
|
+
**[📍 Check out the complete Roadmap →](http://docs.bmad-method.org/roadmap/)**
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
25
35
|
## Quick Start
|
|
26
36
|
|
|
27
37
|
**Prerequisites**: [Node.js](https://nodejs.org) v20+
|
|
@@ -30,7 +40,9 @@ Traditional AI tools do the thinking for you, producing average results. BMad ag
|
|
|
30
40
|
npx bmad-method install
|
|
31
41
|
```
|
|
32
42
|
|
|
33
|
-
|
|
43
|
+
> If you are getting a stale beta version, use: `npx bmad-method@6.0.1 install`
|
|
44
|
+
|
|
45
|
+
Follow the installer prompts, then open your AI IDE (Claude Code, Cursor, etc.) in your project folder.
|
|
34
46
|
|
|
35
47
|
**Non-Interactive Installation** (for CI/CD):
|
|
36
48
|
|
|
@@ -41,14 +41,14 @@ _bmad/_config/agents/
|
|
|
41
41
|
|
|
42
42
|
Open the `.customize.yaml` file for the agent you want to modify. Every section is optional -- customize only what you need.
|
|
43
43
|
|
|
44
|
-
| Section
|
|
45
|
-
|
|
|
46
|
-
| `agent.metadata`
|
|
47
|
-
| `persona`
|
|
48
|
-
| `memories`
|
|
49
|
-
| `menu`
|
|
50
|
-
| `critical_actions`
|
|
51
|
-
| `prompts`
|
|
44
|
+
| Section | Behavior | Purpose |
|
|
45
|
+
| ------------------ | -------- | ----------------------------------------------- |
|
|
46
|
+
| `agent.metadata` | Replaces | Override the agent's display name |
|
|
47
|
+
| `persona` | Replaces | Set role, identity, style, and principles |
|
|
48
|
+
| `memories` | Appends | Add persistent context the agent always recalls |
|
|
49
|
+
| `menu` | Appends | Add custom menu items for workflows or prompts |
|
|
50
|
+
| `critical_actions` | Appends | Define startup instructions for the agent |
|
|
51
|
+
| `prompts` | Appends | Create reusable prompts for menu actions |
|
|
52
52
|
|
|
53
53
|
Sections marked **Replaces** overwrite the agent's defaults entirely. Sections marked **Appends** add to the existing configuration.
|
|
54
54
|
|
|
@@ -96,7 +96,7 @@ Add custom entries to the agent's display menu. Each item needs a `trigger`, a t
|
|
|
96
96
|
```yaml
|
|
97
97
|
menu:
|
|
98
98
|
- trigger: my-workflow
|
|
99
|
-
workflow: '
|
|
99
|
+
workflow: 'my-custom/workflows/my-workflow.yaml'
|
|
100
100
|
description: My custom workflow
|
|
101
101
|
- trigger: deploy
|
|
102
102
|
action: '#deploy-prompt'
|
|
@@ -136,11 +136,11 @@ npx bmad-method install
|
|
|
136
136
|
|
|
137
137
|
The installer detects the existing installation and offers these options:
|
|
138
138
|
|
|
139
|
-
| Option
|
|
140
|
-
|
|
|
141
|
-
| **Quick Update**
|
|
142
|
-
| **Recompile Agents**
|
|
143
|
-
| **Modify BMad Installation** | Full installation flow for adding or removing modules
|
|
139
|
+
| Option | What It Does |
|
|
140
|
+
| ---------------------------- | ------------------------------------------------------------------- |
|
|
141
|
+
| **Quick Update** | Updates all modules to the latest version and recompiles all agents |
|
|
142
|
+
| **Recompile Agents** | Applies customizations only, without updating module files |
|
|
143
|
+
| **Modify BMad Installation** | Full installation flow for adding or removing modules |
|
|
144
144
|
|
|
145
145
|
For customization-only changes, **Recompile Agents** is the fastest option.
|
|
146
146
|
|
|
@@ -12,7 +12,7 @@ This guide covers the essential workflow for onboarding to existing projects wit
|
|
|
12
12
|
:::note[Prerequisites]
|
|
13
13
|
- BMad Method installed (`npx bmad-method install`)
|
|
14
14
|
- An existing codebase you want to work on
|
|
15
|
-
- Access to an AI-powered IDE (Claude Code
|
|
15
|
+
- Access to an AI-powered IDE (Claude Code or Cursor)
|
|
16
16
|
:::
|
|
17
17
|
|
|
18
18
|
## Step 1: Clean Up Completed Planning Artifacts
|
|
@@ -59,9 +59,21 @@ For complex projects, consider using the `document-project` workflow. It offers
|
|
|
59
59
|
|
|
60
60
|
## Step 3: Get Help
|
|
61
61
|
|
|
62
|
-
|
|
62
|
+
### BMad-Help: Your Starting Point
|
|
63
63
|
|
|
64
|
-
Run
|
|
64
|
+
**Run `/bmad-help` anytime you're unsure what to do next.** This intelligent guide:
|
|
65
|
+
|
|
66
|
+
- Inspects your project to see what's already been done
|
|
67
|
+
- Shows options based on your installed modules
|
|
68
|
+
- Understands natural language queries
|
|
69
|
+
|
|
70
|
+
```
|
|
71
|
+
/bmad-help I have an existing Rails app, where should I start?
|
|
72
|
+
/bmad-help What's the difference between quick-flow and full method?
|
|
73
|
+
/bmad-help Show me what workflows are available
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
BMad-Help also **automatically runs at the end of every workflow**, providing clear guidance on exactly what to do next.
|
|
65
77
|
|
|
66
78
|
### Choosing Your Approach
|
|
67
79
|
|
|
@@ -5,17 +5,48 @@ sidebar:
|
|
|
5
5
|
order: 4
|
|
6
6
|
---
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
## Start Here: BMad-Help
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
**The fastest way to get answers about BMad is `/bmad-help`.** This intelligent guide will answer upwards of 80% of all questions and is available to you directly in your IDE as you work.
|
|
11
11
|
|
|
12
|
-
-
|
|
13
|
-
-
|
|
14
|
-
-
|
|
12
|
+
BMad-Help is more than a lookup tool — it:
|
|
13
|
+
- **Inspects your project** to see what's already been completed
|
|
14
|
+
- **Understands natural language** — ask questions in plain English
|
|
15
|
+
- **Varies based on your installed modules** — shows relevant options
|
|
16
|
+
- **Auto-runs after workflows** — tells you exactly what to do next
|
|
17
|
+
- **Recommends the first required task** — no guessing where to start
|
|
15
18
|
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
+
### How to Use BMad-Help
|
|
20
|
+
|
|
21
|
+
Run it with just the slash command:
|
|
22
|
+
|
|
23
|
+
```
|
|
24
|
+
/bmad-help
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Or combine it with a natural language query:
|
|
28
|
+
|
|
29
|
+
```
|
|
30
|
+
/bmad-help I have a SaaS idea and know all the features. Where do I start?
|
|
31
|
+
/bmad-help What are my options for UX design?
|
|
32
|
+
/bmad-help I'm stuck on the PRD workflow
|
|
33
|
+
/bmad-help Show me what's been done so far
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
BMad-Help responds with:
|
|
37
|
+
- What's recommended for your situation
|
|
38
|
+
- What the first required task is
|
|
39
|
+
- What the rest of the process looks like
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
## When to Use This Guide
|
|
44
|
+
|
|
45
|
+
Use this section when:
|
|
46
|
+
- You want to understand BMad's architecture or internals
|
|
47
|
+
- You need answers outside of what BMad-Help provides
|
|
48
|
+
- You're researching BMad before installing
|
|
49
|
+
- You want to explore the source code directly
|
|
19
50
|
|
|
20
51
|
## Steps
|
|
21
52
|
|
|
@@ -18,7 +18,7 @@ If you want to use a non interactive installer and provide all install options o
|
|
|
18
18
|
:::note[Prerequisites]
|
|
19
19
|
- **Node.js** 20+ (required for the installer)
|
|
20
20
|
- **Git** (recommended)
|
|
21
|
-
- **AI tool** (Claude Code, Cursor,
|
|
21
|
+
- **AI tool** (Claude Code, Cursor, or similar)
|
|
22
22
|
:::
|
|
23
23
|
|
|
24
24
|
## Steps
|
|
@@ -49,8 +49,6 @@ Pick which AI tools you use:
|
|
|
49
49
|
|
|
50
50
|
- Claude Code
|
|
51
51
|
- Cursor
|
|
52
|
-
- Windsurf
|
|
53
|
-
- Kiro
|
|
54
52
|
- Others
|
|
55
53
|
|
|
56
54
|
Each tool has its own way of integrating commands. The installer creates tiny prompt files to activate workflows and agents — it just puts them where your tool expects to find them.
|
|
@@ -79,7 +77,18 @@ your-project/
|
|
|
79
77
|
|
|
80
78
|
## Verify Installation
|
|
81
79
|
|
|
82
|
-
Run
|
|
80
|
+
Run `/bmad-help` to verify everything works and see what to do next.
|
|
81
|
+
|
|
82
|
+
**BMad-Help is your intelligent guide** that will:
|
|
83
|
+
- Confirm your installation is working
|
|
84
|
+
- Show what's available based on your installed modules
|
|
85
|
+
- Recommend your first step
|
|
86
|
+
|
|
87
|
+
You can also ask it questions:
|
|
88
|
+
```
|
|
89
|
+
/bmad-help I just installed, what should I do first?
|
|
90
|
+
/bmad-help What are my options for a SaaS project?
|
|
91
|
+
```
|
|
83
92
|
|
|
84
93
|
## Troubleshooting
|
|
85
94
|
|
|
@@ -59,7 +59,7 @@ Check the [BMad registry](https://github.com/bmad-code-org) for available extern
|
|
|
59
59
|
|
|
60
60
|
Available tool IDs for the `--tools` flag:
|
|
61
61
|
|
|
62
|
-
**Preferred:** `claude-code`, `cursor
|
|
62
|
+
**Preferred:** `claude-code`, `cursor`
|
|
63
63
|
|
|
64
64
|
Run `npx bmad-method install` interactively once to see the full current list of supported tools, or check the [platform codes configuration](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/tools/cli/installers/lib/ide/platform-codes.yaml).
|
|
65
65
|
|
|
@@ -16,7 +16,7 @@ Use the **DEV agent** directly for bug fixes, refactorings, or small targeted ch
|
|
|
16
16
|
|
|
17
17
|
:::note[Prerequisites]
|
|
18
18
|
- BMad Method installed (`npx bmad-method install`)
|
|
19
|
-
- An AI-powered IDE (Claude Code, Cursor,
|
|
19
|
+
- An AI-powered IDE (Claude Code, Cursor, or similar)
|
|
20
20
|
:::
|
|
21
21
|
|
|
22
22
|
## Choose Your Approach
|
package/docs/index.md
CHANGED
|
@@ -7,12 +7,20 @@ The BMad Method (**B**reakthrough **M**ethod of **A**gile AI **D**riven Developm
|
|
|
7
7
|
|
|
8
8
|
If you're comfortable working with AI coding assistants like Claude, Cursor, or GitHub Copilot, you're ready to get started.
|
|
9
9
|
|
|
10
|
+
:::note[🚀 V6 is Here and We're Just Getting Started!]
|
|
11
|
+
Skills Architecture, BMad Builder v1, Dev Loop Automation, and so much more in the works. **[Check out the Roadmap →](/roadmap/)**
|
|
12
|
+
:::
|
|
13
|
+
|
|
10
14
|
## New Here? Start with a Tutorial
|
|
11
15
|
|
|
12
16
|
The fastest way to understand BMad is to try it.
|
|
13
17
|
|
|
14
18
|
- **[Get Started with BMad](./tutorials/getting-started.md)** — Install and understand how BMad works
|
|
15
|
-
- **[Workflow Map](./reference/workflow-map.md)** — Visual overview of BMM phases, workflows, and context management
|
|
19
|
+
- **[Workflow Map](./reference/workflow-map.md)** — Visual overview of BMM phases, workflows, and context management
|
|
20
|
+
|
|
21
|
+
:::tip[Just Want to Dive In?]
|
|
22
|
+
Install BMad and run `/bmad-help` — it will guide you through everything based on your project and installed modules.
|
|
23
|
+
:::
|
|
16
24
|
|
|
17
25
|
## How to Use These Docs
|
|
18
26
|
|
|
@@ -35,9 +43,7 @@ BMad works with any AI coding assistant that supports custom system prompts or p
|
|
|
35
43
|
|
|
36
44
|
- **[Claude Code](https://code.claude.com)** — Anthropic's CLI tool (recommended)
|
|
37
45
|
- **[Cursor](https://cursor.sh)** — AI-first code editor
|
|
38
|
-
- **[
|
|
39
|
-
- **[Kiro](https://kiro.dev)** — Amazon's AI-powered IDE
|
|
40
|
-
- **[Roo Code](https://roocode.com)** — VS Code extension
|
|
46
|
+
- **[Codex CLI](https://github.com/openai/codex)** — OpenAI's terminal coding agent
|
|
41
47
|
|
|
42
48
|
You should be comfortable with basic software development concepts like version control, project structure, and agile workflows. No prior experience with BMad-style agent systems is required—that's what these docs are for.
|
|
43
49
|
|
|
@@ -103,9 +103,29 @@ See [Workflow Map](./workflow-map.md) for the complete workflow reference organi
|
|
|
103
103
|
|
|
104
104
|
Tasks and tools are standalone operations that do not require an agent or workflow context.
|
|
105
105
|
|
|
106
|
+
#### BMad-Help: Your Intelligent Guide
|
|
107
|
+
|
|
108
|
+
**`/bmad-help`** is your primary interface for discovering what to do next. It's not just a lookup tool — it's an intelligent assistant that:
|
|
109
|
+
|
|
110
|
+
- **Inspects your project** to see what's already been done
|
|
111
|
+
- **Understands natural language queries** — ask questions in plain English
|
|
112
|
+
- **Varies by installed modules** — shows options based on what you have
|
|
113
|
+
- **Auto-invokes after workflows** — every workflow ends with clear next steps
|
|
114
|
+
- **Recommends the first required task** — no guessing where to start
|
|
115
|
+
|
|
116
|
+
**Examples:**
|
|
117
|
+
|
|
118
|
+
```
|
|
119
|
+
/bmad-help
|
|
120
|
+
/bmad-help I have a SaaS idea and know all the features. Where do I start?
|
|
121
|
+
/bmad-help What are my options for UX design?
|
|
122
|
+
/bmad-help I'm stuck on the PRD workflow
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
#### Other Tasks and Tools
|
|
126
|
+
|
|
106
127
|
| Example command | Purpose |
|
|
107
128
|
| --- | --- |
|
|
108
|
-
| `/bmad-help` | Context-aware guidance and next-step recommendations |
|
|
109
129
|
| `/bmad-shard-doc` | Split a large markdown file into smaller sections |
|
|
110
130
|
| `/bmad-index-docs` | Index project documentation |
|
|
111
131
|
| `/bmad-editorial-review-prose` | Review document prose quality |
|