bmad-method 6.0.0-Beta.7 → 6.0.0-Beta.8
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/.augment/code_review_guidelines.yaml +271 -0
- package/.coderabbit.yaml +56 -11
- package/.github/PULL_REQUEST_TEMPLATE.md +13 -0
- package/.github/workflows/coderabbit-review.yaml +22 -0
- package/.github/workflows/docs.yaml +4 -3
- package/.github/workflows/quality.yaml +1 -3
- package/CHANGELOG.md +53 -0
- package/CONTRIBUTING.md +9 -0
- package/README.md +8 -0
- package/docs/404.md +1 -1
- package/docs/_STYLE_GUIDE.md +3 -2
- package/docs/explanation/advanced-elicitation.md +26 -1
- package/docs/explanation/adversarial-review.md +3 -1
- package/docs/explanation/brainstorming.md +2 -0
- package/docs/explanation/established-projects-faq.md +50 -0
- package/docs/explanation/party-mode.md +2 -0
- package/docs/explanation/preventing-agent-conflicts.md +3 -1
- package/docs/explanation/quick-flow.md +60 -14
- package/docs/explanation/why-solutioning-matters.md +4 -2
- package/docs/how-to/customize-bmad.md +72 -58
- package/docs/how-to/{brownfield/index.md → established-projects.md} +9 -11
- package/docs/how-to/get-answers-about-bmad.md +3 -2
- package/docs/how-to/install-bmad.md +16 -10
- package/docs/how-to/non-interactive-installation.md +171 -0
- package/docs/how-to/quick-fixes.md +123 -0
- package/docs/how-to/shard-large-documents.md +13 -36
- package/docs/how-to/upgrade-to-v6.md +28 -62
- package/docs/index.md +6 -12
- package/docs/reference/agents.md +9 -3
- package/docs/reference/commands.md +116 -19
- package/docs/reference/modules.md +76 -0
- package/docs/reference/testing.md +94 -9
- package/docs/reference/workflow-map.md +9 -5
- package/docs/tutorials/getting-started.md +2 -2
- package/eslint.config.mjs +5 -16
- package/package.json +4 -15
- package/src/bmm/module.yaml +6 -0
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-06-complete.md +1 -1
- package/src/bmm/workflows/1-analysis/research/technical-steps/step-04-architectural-patterns.md +1 -1
- package/src/bmm/workflows/1-analysis/research/technical-steps/step-05-implementation-research.md +28 -34
- package/src/bmm/workflows/1-analysis/research/technical-steps/step-06-research-synthesis.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-ux-design/steps/step-14-complete.md +1 -1
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-01-document-discovery.md +1 -7
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-02-prd-analysis.md +0 -6
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-03-epic-coverage-validation.md +0 -6
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-04-ux-alignment.md +0 -6
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-05-epic-quality-review.md +0 -7
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md +1 -7
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-08-complete.md +1 -1
- package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md +1 -1
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md +0 -2
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md +0 -2
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md +0 -2
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-04-self-check.md +0 -2
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md +1 -3
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-06-resolve-findings.md +0 -3
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-01-understand.md +1 -2
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-02-investigate.md +0 -1
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-03-generate.md +0 -1
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-04-review.md +1 -2
- package/src/core/tasks/help.md +9 -6
- package/src/core/workflows/party-mode/steps/step-03-graceful-exit.md +11 -0
- package/test/fixtures/file-refs-csv/invalid/all-empty-workflow.csv +3 -0
- package/test/fixtures/file-refs-csv/invalid/empty-data.csv +1 -0
- package/test/fixtures/file-refs-csv/invalid/no-workflow-column.csv +3 -0
- package/test/fixtures/file-refs-csv/invalid/unresolvable-vars.csv +3 -0
- package/test/fixtures/file-refs-csv/valid/bmm-style.csv +3 -0
- package/test/fixtures/file-refs-csv/valid/core-style.csv +3 -0
- package/test/fixtures/file-refs-csv/valid/minimal.csv +2 -0
- package/test/test-file-refs-csv.js +133 -0
- package/test/test-rehype-plugins.mjs +1050 -0
- package/tools/{build-docs.js → build-docs.mjs} +29 -163
- package/tools/cli/bmad-cli.js +19 -11
- package/tools/cli/commands/install.js +35 -19
- package/tools/cli/commands/status.js +9 -9
- package/tools/cli/external-official-modules.yaml +11 -12
- package/tools/cli/installers/lib/core/config-collector.js +67 -88
- package/tools/cli/installers/lib/core/dependency-resolver.js +20 -16
- package/tools/cli/installers/lib/core/installer.js +241 -233
- package/tools/cli/installers/lib/custom/handler.js +10 -15
- package/tools/cli/installers/lib/ide/_base-ide.js +3 -3
- package/tools/cli/installers/lib/ide/_config-driven.js +21 -28
- package/tools/cli/installers/lib/ide/codex.js +37 -63
- package/tools/cli/installers/lib/ide/kilo.js +134 -115
- package/tools/cli/installers/lib/ide/manager.js +44 -16
- package/tools/cli/installers/lib/ide/platform-codes.yaml +14 -7
- package/tools/cli/installers/lib/ide/shared/agent-command-generator.js +0 -1
- package/tools/cli/installers/lib/ide/shared/task-tool-command-generator.js +4 -5
- package/tools/cli/installers/lib/ide/shared/workflow-command-generator.js +10 -11
- package/tools/cli/installers/lib/ide/templates/{split/opencode/body.md → combined/kiro-agent.md} +7 -1
- package/tools/cli/installers/lib/ide/templates/combined/kiro-task.md +9 -0
- package/tools/cli/installers/lib/ide/templates/combined/kiro-tool.md +9 -0
- package/tools/cli/installers/lib/ide/templates/combined/kiro-workflow-yaml.md +15 -0
- package/tools/cli/installers/lib/ide/templates/combined/kiro-workflow.md +7 -0
- package/tools/cli/installers/lib/ide/templates/combined/opencode-agent.md +15 -0
- package/tools/cli/installers/lib/ide/templates/combined/opencode-task.md +12 -0
- package/tools/cli/installers/lib/ide/templates/combined/opencode-tool.md +12 -0
- package/tools/cli/installers/lib/ide/templates/combined/opencode-workflow-yaml.md +15 -0
- package/tools/cli/installers/lib/ide/templates/combined/opencode-workflow.md +15 -0
- package/tools/cli/installers/lib/ide/templates/split/.gitkeep +0 -0
- package/tools/cli/installers/lib/message-loader.js +5 -7
- package/tools/cli/installers/lib/modules/manager.js +172 -121
- package/tools/cli/lib/agent/installer.js +19 -55
- package/tools/cli/lib/cli-utils.js +55 -100
- package/tools/cli/lib/prompts.js +221 -31
- package/tools/cli/lib/ui.js +484 -369
- package/tools/docs/_prompt-external-modules-page.md +59 -0
- package/tools/fix-doc-links.js +4 -7
- package/tools/platform-codes.yaml +4 -4
- package/tools/validate-doc-links.js +29 -7
- package/tools/validate-file-refs.js +176 -102
- package/website/README.md +0 -1
- package/website/astro.config.mjs +1 -1
- package/website/src/components/Banner.astro +12 -9
- package/website/src/components/Header.astro +1 -26
- package/website/src/components/MobileMenuFooter.astro +0 -20
- package/website/{public/robots.txt → src/pages/robots.txt.ts} +14 -3
- package/website/src/rehype-base-paths.js +46 -23
- package/website/src/rehype-markdown-links.js +80 -86
- package/website/src/styles/custom.css +33 -24
- package/.claude/skills/changelog-social.skill +0 -0
- package/.github/workflows/manual-release.yaml +0 -193
- package/docs/bmgd/bmgd-logo.png +0 -0
- package/docs/bmgd/game-types.md +0 -375
- package/docs/bmgd/index.md +0 -113
- package/docs/bmgd/quick-flow-workflows.md +0 -161
- package/docs/bmgd/workflow.jpg +0 -0
- package/docs/downloads.md +0 -74
- package/docs/explanation/brownfield-faq.md +0 -55
- package/docs/how-to/brownfield/quick-fix-in-brownfield.md +0 -76
- package/src/bmm/_module-installer/installer.js +0 -48
- package/src/core/_module-installer/installer.js +0 -60
- package/tools/cli/installers/lib/ide/kiro-cli.js +0 -326
- package/tools/cli/installers/lib/ide/templates/split/opencode/header.md +0 -4
- package/tools/docs/BUNDLE_DISTRIBUTION_SETUP.md +0 -95
- package/tools/docs/index.md +0 -2
- package/website/_basement/components/WorkflowGuide.astro +0 -444
- package/website/_basement/pages/workflow-guide.astro +0 -17
- package/website/public/img/logo.svg +0 -4
- package/website/public/img/workflow-map.png +0 -0
- /package/website/src/lib/{site-url.js → site-url.mjs} +0 -0
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Established Projects FAQ"
|
|
3
|
+
description: Common questions about using BMad Method on established projects
|
|
4
|
+
sidebar:
|
|
5
|
+
order: 8
|
|
6
|
+
---
|
|
7
|
+
Quick answers to common questions about working on established projects with the BMad Method (BMM).
|
|
8
|
+
|
|
9
|
+
## Questions
|
|
10
|
+
|
|
11
|
+
- [Do I have to run document-project first?](#do-i-have-to-run-document-project-first)
|
|
12
|
+
- [What if I forget to run document-project?](#what-if-i-forget-to-run-document-project)
|
|
13
|
+
- [Can I use Quick Flow for established projects?](#can-i-use-quick-flow-for-established-projects)
|
|
14
|
+
- [What if my existing code doesn't follow best practices?](#what-if-my-existing-code-doesnt-follow-best-practices)
|
|
15
|
+
|
|
16
|
+
### Do I have to run document-project first?
|
|
17
|
+
|
|
18
|
+
Highly recommended, especially if:
|
|
19
|
+
|
|
20
|
+
- No existing documentation
|
|
21
|
+
- Documentation is outdated
|
|
22
|
+
- AI agents need context about existing code
|
|
23
|
+
|
|
24
|
+
You can skip it if you have comprehensive, up-to-date documentation including `docs/index.md` or will use other tools or techniques to aid in discovery for the agent to build on an existing system.
|
|
25
|
+
|
|
26
|
+
### What if I forget to run document-project?
|
|
27
|
+
|
|
28
|
+
Don't worry about it - you can do it at any time. You can even do it during or after a project to help keep docs up to date.
|
|
29
|
+
|
|
30
|
+
### Can I use Quick Flow for established projects?
|
|
31
|
+
|
|
32
|
+
Yes! Quick Flow works great for established projects. It will:
|
|
33
|
+
|
|
34
|
+
- Auto-detect your existing stack
|
|
35
|
+
- Analyze existing code patterns
|
|
36
|
+
- Detect conventions and ask for confirmation
|
|
37
|
+
- Generate context-rich tech-spec that respects existing code
|
|
38
|
+
|
|
39
|
+
Perfect for bug fixes and small features in existing codebases.
|
|
40
|
+
|
|
41
|
+
### What if my existing code doesn't follow best practices?
|
|
42
|
+
|
|
43
|
+
Quick Flow detects your conventions and asks: "Should I follow these existing conventions?" You decide:
|
|
44
|
+
|
|
45
|
+
- **Yes** → Maintain consistency with current codebase
|
|
46
|
+
- **No** → Establish new standards (document why in tech-spec)
|
|
47
|
+
|
|
48
|
+
BMM respects your choice — it won't force modernization, but it will offer it.
|
|
49
|
+
|
|
50
|
+
**Have a question not answered here?** Please [open an issue](https://github.com/bmad-code-org/BMAD-METHOD/issues) or ask in [Discord](https://discord.gg/gk8jAdXWmj) so we can add it!
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Preventing Agent Conflicts"
|
|
3
3
|
description: How architecture prevents conflicts when multiple agents implement a system
|
|
4
|
+
sidebar:
|
|
5
|
+
order: 4
|
|
4
6
|
---
|
|
5
7
|
|
|
6
8
|
When multiple AI agents implement different parts of a system, they can make conflicting technical decisions. Architecture documentation prevents this by establishing shared standards.
|
|
@@ -69,7 +71,7 @@ Explicit documentation of:
|
|
|
69
71
|
|
|
70
72
|
Think of architecture as the shared context that all agents read before implementing:
|
|
71
73
|
|
|
72
|
-
```
|
|
74
|
+
```text
|
|
73
75
|
PRD: "What to build"
|
|
74
76
|
↓
|
|
75
77
|
Architecture: "How to build it"
|
|
@@ -1,27 +1,73 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Quick Flow"
|
|
3
3
|
description: Fast-track for small changes - skip the full methodology
|
|
4
|
+
sidebar:
|
|
5
|
+
order: 1
|
|
4
6
|
---
|
|
5
7
|
|
|
6
|
-
Quick Flow
|
|
8
|
+
Skip the ceremony. Quick Flow takes you from idea to working code in two commands - no Product Brief, no PRD, no Architecture doc.
|
|
9
|
+
|
|
10
|
+
## When to Use It
|
|
11
|
+
|
|
12
|
+
- Bug fixes and patches
|
|
13
|
+
- Refactoring existing code
|
|
14
|
+
- Small, well-understood features
|
|
15
|
+
- Prototyping and spikes
|
|
16
|
+
- Single-agent work where one developer can hold the full scope
|
|
17
|
+
|
|
18
|
+
## When NOT to Use It
|
|
19
|
+
|
|
20
|
+
- New products or platforms that need stakeholder alignment
|
|
21
|
+
- Major features spanning multiple components or teams
|
|
22
|
+
- Work that requires architectural decisions (database schema, API contracts, service boundaries)
|
|
23
|
+
- Anything where requirements are unclear or contested
|
|
24
|
+
|
|
25
|
+
:::caution[Scope Creep]
|
|
26
|
+
If you start a Quick Flow and realize the scope is bigger than expected, `quick-dev` will detect this and offer to escalate. You can switch to a full PRD workflow at any point without losing your work.
|
|
27
|
+
:::
|
|
7
28
|
|
|
8
29
|
## How It Works
|
|
9
30
|
|
|
10
|
-
|
|
11
|
-
2. **Run `quick-dev`** — implements it
|
|
31
|
+
Quick Flow has two commands, each backed by a structured workflow. You can run them together or independently.
|
|
12
32
|
|
|
13
|
-
|
|
33
|
+
### quick-spec: Plan
|
|
14
34
|
|
|
15
|
-
|
|
35
|
+
Run `quick-spec` and Barry (the Quick Flow agent) walks you through a conversational discovery process:
|
|
36
|
+
|
|
37
|
+
1. **Understand** - You describe what you want to build. Barry scans the codebase to ask informed questions, then captures a problem statement, solution approach, and scope boundaries.
|
|
38
|
+
2. **Investigate** - Barry reads relevant files, maps code patterns, identifies files to modify, and documents the technical context.
|
|
39
|
+
3. **Generate** - Produces a complete tech-spec with ordered implementation tasks (specific file paths and actions), acceptance criteria in Given/When/Then format, testing strategy, and dependencies.
|
|
40
|
+
4. **Review** - Presents the full spec for your sign-off. You can edit, ask questions, run adversarial review, or refine with advanced elicitation before finalizing.
|
|
41
|
+
|
|
42
|
+
The output is a `tech-spec-{slug}.md` file saved to your project's implementation artifacts folder. It contains everything a fresh agent needs to implement the feature - no conversation history required.
|
|
43
|
+
|
|
44
|
+
### quick-dev: Build
|
|
45
|
+
|
|
46
|
+
Run `quick-dev` and Barry implements the work. It operates in two modes:
|
|
47
|
+
|
|
48
|
+
- **Tech-spec mode** - Point it at a spec file (`quick-dev tech-spec-auth.md`) and it executes every task in order, writes tests, and verifies acceptance criteria.
|
|
49
|
+
- **Direct mode** - Give it instructions directly (`quick-dev "refactor the auth middleware"`) and it gathers context, builds a mental plan, and executes.
|
|
50
|
+
|
|
51
|
+
After implementation, `quick-dev` runs a self-check audit against all tasks and acceptance criteria, then triggers an adversarial code review of the diff. Findings are presented for you to resolve before wrapping up.
|
|
52
|
+
|
|
53
|
+
:::tip[Fresh Context]
|
|
54
|
+
For best results, run `quick-dev` in a new conversation after finishing `quick-spec`. This gives the implementation agent clean context focused solely on building.
|
|
55
|
+
:::
|
|
56
|
+
|
|
57
|
+
## What Quick Flow Skips
|
|
58
|
+
|
|
59
|
+
The full BMad Method produces a Product Brief, PRD, Architecture doc, and Epic/Story breakdown before any code is written. Quick Flow replaces all of that with a single tech-spec. This works because Quick Flow targets changes where:
|
|
60
|
+
|
|
61
|
+
- The product direction is already established
|
|
62
|
+
- Architecture decisions are already made
|
|
63
|
+
- A single developer can reason about the full scope
|
|
64
|
+
- Requirements fit in one conversation
|
|
65
|
+
|
|
66
|
+
## Escalating to Full BMad Method
|
|
16
67
|
|
|
17
|
-
-
|
|
18
|
-
- Refactoring
|
|
19
|
-
- Small features
|
|
20
|
-
- Prototyping
|
|
68
|
+
Quick Flow includes built-in guardrails for scope detection. When you run `quick-dev` with a direct request, it evaluates signals like multi-component mentions, system-level language, and uncertainty about approach. If it detects the work is bigger than a quick flow:
|
|
21
69
|
|
|
22
|
-
|
|
70
|
+
- **Light escalation** - Recommends running `quick-spec` first to create a plan
|
|
71
|
+
- **Heavy escalation** - Recommends switching to the full BMad Method PRD process
|
|
23
72
|
|
|
24
|
-
-
|
|
25
|
-
- Major features
|
|
26
|
-
- Multiple teams involved
|
|
27
|
-
- Stakeholder alignment needed
|
|
73
|
+
You can also escalate manually at any time. Your tech-spec work carries forward - it becomes input for the broader planning process rather than being discarded.
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Why Solutioning Matters"
|
|
3
3
|
description: Understanding why the solutioning phase is critical for multi-epic projects
|
|
4
|
+
sidebar:
|
|
5
|
+
order: 3
|
|
4
6
|
---
|
|
5
7
|
|
|
6
8
|
|
|
@@ -8,7 +10,7 @@ Phase 3 (Solutioning) translates **what** to build (from Planning) into **how**
|
|
|
8
10
|
|
|
9
11
|
## The Problem Without Solutioning
|
|
10
12
|
|
|
11
|
-
```
|
|
13
|
+
```text
|
|
12
14
|
Agent 1 implements Epic 1 using REST API
|
|
13
15
|
Agent 2 implements Epic 2 using GraphQL
|
|
14
16
|
Result: Inconsistent API design, integration nightmare
|
|
@@ -18,7 +20,7 @@ When multiple agents implement different parts of a system without shared archit
|
|
|
18
20
|
|
|
19
21
|
## The Solution With Solutioning
|
|
20
22
|
|
|
21
|
-
```
|
|
23
|
+
```text
|
|
22
24
|
architecture workflow decides: "Use GraphQL for all APIs"
|
|
23
25
|
All agents follow architecture decisions
|
|
24
26
|
Result: Consistent implementation, no conflicts
|
|
@@ -1,33 +1,35 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "
|
|
2
|
+
title: "How to Customize BMad"
|
|
3
|
+
description: Customize agents, workflows, and modules while preserving update compatibility
|
|
4
|
+
sidebar:
|
|
5
|
+
order: 7
|
|
3
6
|
---
|
|
4
7
|
|
|
5
|
-
|
|
8
|
+
Use the `.customize.yaml` files to tailor agent behavior, personas, and menus while preserving your changes across updates.
|
|
6
9
|
|
|
7
|
-
|
|
10
|
+
## When to Use This
|
|
8
11
|
|
|
9
|
-
|
|
12
|
+
- You want to change an agent's name, personality, or communication style
|
|
13
|
+
- You need agents to remember project-specific context
|
|
14
|
+
- You want to add custom menu items that trigger your own workflows or prompts
|
|
15
|
+
- You want agents to perform specific actions every time they start up
|
|
10
16
|
|
|
11
|
-
|
|
17
|
+
:::note[Prerequisites]
|
|
18
|
+
- BMad installed in your project (see [How to Install BMad](./install-bmad.md))
|
|
19
|
+
- A text editor for YAML files
|
|
20
|
+
:::
|
|
12
21
|
|
|
13
|
-
|
|
22
|
+
:::caution[Keep Your Customizations Safe]
|
|
23
|
+
Always use the `.customize.yaml` files described here rather than editing agent files directly. The installer overwrites agent files during updates, but preserves your `.customize.yaml` changes.
|
|
24
|
+
:::
|
|
14
25
|
|
|
15
|
-
##
|
|
26
|
+
## Steps
|
|
16
27
|
|
|
17
|
-
###
|
|
28
|
+
### 1. Locate Customization Files
|
|
18
29
|
|
|
19
|
-
|
|
20
|
-
- Add project-specific memories or context
|
|
21
|
-
- Add custom menu items to custom or inline prompts, skills or custom BMad workflows
|
|
22
|
-
- Define critical actions that occur agent startup for consistent behavior
|
|
30
|
+
After installation, find one `.customize.yaml` file per agent in:
|
|
23
31
|
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
**1. Locate Customization Files**
|
|
27
|
-
|
|
28
|
-
After installation, find agent customization files in:
|
|
29
|
-
|
|
30
|
-
```
|
|
32
|
+
```text
|
|
31
33
|
_bmad/_config/agents/
|
|
32
34
|
├── core-bmad-master.customize.yaml
|
|
33
35
|
├── bmm-dev.customize.yaml
|
|
@@ -35,28 +37,22 @@ _bmad/_config/agents/
|
|
|
35
37
|
└── ... (one file per installed agent)
|
|
36
38
|
```
|
|
37
39
|
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
Open the `.customize.yaml` file for the agent you want to modify. All sections are optional - customize only what you need.
|
|
41
|
-
|
|
42
|
-
**3. Rebuild the Agent**
|
|
43
|
-
|
|
44
|
-
After editing, IT IS CRITICAL to rebuild the agent to apply changes:
|
|
45
|
-
|
|
46
|
-
```bash
|
|
47
|
-
npx bmad-method install
|
|
48
|
-
```
|
|
40
|
+
### 2. Edit the Customization File
|
|
49
41
|
|
|
50
|
-
|
|
42
|
+
Open the `.customize.yaml` file for the agent you want to modify. Every section is optional -- customize only what you need.
|
|
51
43
|
|
|
52
|
-
|
|
53
|
-
|
|
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 |
|
|
54
52
|
|
|
55
|
-
|
|
53
|
+
Sections marked **Replaces** overwrite the agent's defaults entirely. Sections marked **Appends** add to the existing configuration.
|
|
56
54
|
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
#### Agent Name
|
|
55
|
+
**Agent Name**
|
|
60
56
|
|
|
61
57
|
Change how the agent introduces itself:
|
|
62
58
|
|
|
@@ -66,7 +62,7 @@ agent:
|
|
|
66
62
|
name: 'Spongebob' # Default: "Amelia"
|
|
67
63
|
```
|
|
68
64
|
|
|
69
|
-
|
|
65
|
+
**Persona**
|
|
70
66
|
|
|
71
67
|
Replace the agent's personality, role, and communication style:
|
|
72
68
|
|
|
@@ -80,9 +76,9 @@ persona:
|
|
|
80
76
|
- 'Favor composition over inheritance'
|
|
81
77
|
```
|
|
82
78
|
|
|
83
|
-
|
|
79
|
+
The `persona` section replaces the entire default persona, so include all four fields if you set it.
|
|
84
80
|
|
|
85
|
-
|
|
81
|
+
**Memories**
|
|
86
82
|
|
|
87
83
|
Add persistent context the agent will always remember:
|
|
88
84
|
|
|
@@ -90,12 +86,12 @@ Add persistent context the agent will always remember:
|
|
|
90
86
|
memories:
|
|
91
87
|
- 'Works at Krusty Krab'
|
|
92
88
|
- 'Favorite Celebrity: David Hasslehoff'
|
|
93
|
-
- 'Learned in Epic 1 that
|
|
89
|
+
- 'Learned in Epic 1 that it is not cool to just pretend that tests have passed'
|
|
94
90
|
```
|
|
95
91
|
|
|
96
|
-
|
|
92
|
+
**Menu Items**
|
|
97
93
|
|
|
98
|
-
|
|
94
|
+
Add custom entries to the agent's display menu. Each item needs a `trigger`, a target (`workflow` path or `action` reference), and a `description`:
|
|
99
95
|
|
|
100
96
|
```yaml
|
|
101
97
|
menu:
|
|
@@ -107,18 +103,18 @@ menu:
|
|
|
107
103
|
description: Deploy to production
|
|
108
104
|
```
|
|
109
105
|
|
|
110
|
-
|
|
106
|
+
**Critical Actions**
|
|
111
107
|
|
|
112
|
-
|
|
108
|
+
Define instructions that run when the agent starts up:
|
|
113
109
|
|
|
114
110
|
```yaml
|
|
115
111
|
critical_actions:
|
|
116
112
|
- 'Check the CI Pipelines with the XYZ Skill and alert user on wake if anything is urgently needing attention'
|
|
117
113
|
```
|
|
118
114
|
|
|
119
|
-
|
|
115
|
+
**Custom Prompts**
|
|
120
116
|
|
|
121
|
-
|
|
117
|
+
Create reusable prompts that menu items can reference with `action="#id"`:
|
|
122
118
|
|
|
123
119
|
```yaml
|
|
124
120
|
prompts:
|
|
@@ -130,29 +126,47 @@ prompts:
|
|
|
130
126
|
3. Execute deployment script
|
|
131
127
|
```
|
|
132
128
|
|
|
129
|
+
### 3. Apply Your Changes
|
|
130
|
+
|
|
131
|
+
After editing, recompile the agent to apply changes:
|
|
132
|
+
|
|
133
|
+
```bash
|
|
134
|
+
npx bmad-method install
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
The installer detects the existing installation and offers these options:
|
|
138
|
+
|
|
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
|
+
|
|
145
|
+
For customization-only changes, **Recompile Agents** is the fastest option.
|
|
146
|
+
|
|
133
147
|
## Troubleshooting
|
|
134
148
|
|
|
135
149
|
**Changes not appearing?**
|
|
136
150
|
|
|
137
|
-
-
|
|
138
|
-
- Check YAML syntax is valid (indentation matters
|
|
139
|
-
- Verify
|
|
151
|
+
- Run `npx bmad-method install` and select **Recompile Agents** to apply changes
|
|
152
|
+
- Check that your YAML syntax is valid (indentation matters)
|
|
153
|
+
- Verify you edited the correct `.customize.yaml` file for the agent
|
|
140
154
|
|
|
141
155
|
**Agent not loading?**
|
|
142
156
|
|
|
143
|
-
- Check for YAML syntax errors
|
|
144
|
-
- Ensure
|
|
145
|
-
- Try reverting to the template and rebuilding
|
|
157
|
+
- Check for YAML syntax errors using an online YAML validator
|
|
158
|
+
- Ensure you did not leave fields empty after uncommenting them
|
|
159
|
+
- Try reverting to the original template and rebuilding
|
|
146
160
|
|
|
147
|
-
**Need to reset?**
|
|
161
|
+
**Need to reset an agent?**
|
|
148
162
|
|
|
149
|
-
-
|
|
150
|
-
- Run `npx bmad-method
|
|
163
|
+
- Clear or delete the agent's `.customize.yaml` file
|
|
164
|
+
- Run `npx bmad-method install` and select **Recompile Agents** to restore defaults
|
|
151
165
|
|
|
152
166
|
## Workflow Customization
|
|
153
167
|
|
|
154
|
-
|
|
168
|
+
Customization of existing BMad Method workflows and skills is coming soon.
|
|
155
169
|
|
|
156
170
|
## Module Customization
|
|
157
171
|
|
|
158
|
-
|
|
172
|
+
Guidance on building expansion modules and customizing existing modules is coming soon.
|
|
@@ -1,15 +1,13 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "
|
|
2
|
+
title: "Established Projects"
|
|
3
3
|
description: How to use BMad Method on existing codebases
|
|
4
|
+
sidebar:
|
|
5
|
+
order: 6
|
|
4
6
|
---
|
|
5
7
|
|
|
6
|
-
Use BMad Method effectively when working on existing projects and legacy codebases.
|
|
8
|
+
Use BMad Method effectively when working on existing projects and legacy codebases, sometimes also referred to as brownfield projects.
|
|
7
9
|
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
**Brownfield** refers to working on existing projects with established codebases and patterns, as opposed to **greenfield** which means starting from scratch with a clean slate.
|
|
11
|
-
|
|
12
|
-
This guide covers the essential workflow for onboarding to brownfield projects with BMad Method.
|
|
10
|
+
This guide covers the essential workflow for onboarding to existing projects with BMad Method.
|
|
13
11
|
|
|
14
12
|
:::note[Prerequisites]
|
|
15
13
|
- BMad Method installed (`npx bmad-method install`)
|
|
@@ -48,8 +46,8 @@ You have two primary options depending on the scope of changes:
|
|
|
48
46
|
|
|
49
47
|
| Scope | Recommended Approach |
|
|
50
48
|
| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------- |
|
|
51
|
-
| **Small updates or additions** | Use `quick-flow-solo-dev` to create a tech-spec and implement the change. The full four-phase BMad
|
|
52
|
-
| **Major changes or additions** | Start with the BMad
|
|
49
|
+
| **Small updates or additions** | Use `quick-flow-solo-dev` to create a tech-spec and implement the change. The full four-phase BMad Method is likely overkill. |
|
|
50
|
+
| **Major changes or additions** | Start with the BMad Method, applying as much or as little rigor as needed. |
|
|
53
51
|
|
|
54
52
|
### During PRD Creation
|
|
55
53
|
|
|
@@ -80,5 +78,5 @@ Pay close attention here to prevent reinventing the wheel or making decisions th
|
|
|
80
78
|
|
|
81
79
|
## More Information
|
|
82
80
|
|
|
83
|
-
- **[Quick
|
|
84
|
-
- **[
|
|
81
|
+
- **[Quick Fixes](./quick-fixes.md)** - Bug fixes and ad-hoc changes
|
|
82
|
+
- **[Established Projects FAQ](../explanation/established-projects-faq.md)** - Common questions about working on established projects
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "How to Get Answers About BMad"
|
|
3
3
|
description: Use an LLM to quickly answer your own BMad questions
|
|
4
|
+
sidebar:
|
|
5
|
+
order: 4
|
|
4
6
|
---
|
|
5
7
|
|
|
6
8
|
If you have successfully installed BMad and the BMad Method (+ other modules as needed) - the first step in getting answers is `/bmad-help`. This will answer upwards of 80% of all questions and is available to you in the IDE as you are working.
|
|
@@ -38,11 +40,10 @@ The `_bmad` folder is created when you install BMad. If you don't have it yet, c
|
|
|
38
40
|
|
|
39
41
|
Fetch `llms-full.txt` into your session:
|
|
40
42
|
|
|
41
|
-
```
|
|
43
|
+
```text
|
|
42
44
|
https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt
|
|
43
45
|
```
|
|
44
46
|
|
|
45
|
-
See the [Downloads page](/docs/downloads.md) for other downloadable resources.
|
|
46
47
|
|
|
47
48
|
### 3. Ask Your Question
|
|
48
49
|
|
|
@@ -1,10 +1,14 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "How to Install BMad"
|
|
3
3
|
description: Step-by-step guide to installing BMad in your project
|
|
4
|
+
sidebar:
|
|
5
|
+
order: 1
|
|
4
6
|
---
|
|
5
7
|
|
|
6
8
|
Use the `npx bmad-method install` command to set up BMad in your project with your choice of modules and AI tools.
|
|
7
9
|
|
|
10
|
+
If you want to use a non interactive installer and provide all install options on the command line, see [this guide](./non-interactive-installation.md).
|
|
11
|
+
|
|
8
12
|
## When to Use This
|
|
9
13
|
|
|
10
14
|
- Starting a new project with BMad
|
|
@@ -25,6 +29,13 @@ Use the `npx bmad-method install` command to set up BMad in your project with yo
|
|
|
25
29
|
npx bmad-method install
|
|
26
30
|
```
|
|
27
31
|
|
|
32
|
+
:::tip[Bleeding edge]
|
|
33
|
+
To install the latest from the main branch (may be unstable):
|
|
34
|
+
```bash
|
|
35
|
+
npx github:bmad-code-org/BMAD-METHOD install
|
|
36
|
+
```
|
|
37
|
+
:::
|
|
38
|
+
|
|
28
39
|
### 2. Choose Installation Location
|
|
29
40
|
|
|
30
41
|
The installer will ask where to install BMad files:
|
|
@@ -39,6 +50,7 @@ Pick which AI tools you use:
|
|
|
39
50
|
- Claude Code
|
|
40
51
|
- Cursor
|
|
41
52
|
- Windsurf
|
|
53
|
+
- Kiro
|
|
42
54
|
- Others
|
|
43
55
|
|
|
44
56
|
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.
|
|
@@ -53,7 +65,7 @@ The installer guides you through the rest — custom content, settings, etc.
|
|
|
53
65
|
|
|
54
66
|
## What You Get
|
|
55
67
|
|
|
56
|
-
```
|
|
68
|
+
```text
|
|
57
69
|
your-project/
|
|
58
70
|
├── _bmad/
|
|
59
71
|
│ ├── bmm/ # Your selected modules
|
|
@@ -61,22 +73,16 @@ your-project/
|
|
|
61
73
|
│ ├── core/ # Required core module
|
|
62
74
|
│ └── ...
|
|
63
75
|
├── _bmad-output/ # Generated artifacts
|
|
64
|
-
|
|
76
|
+
├── .claude/ # Claude Code commands (if using Claude Code)
|
|
77
|
+
└── .kiro/ # Kiro steering files (if using Kiro)
|
|
65
78
|
```
|
|
66
79
|
|
|
67
80
|
## Verify Installation
|
|
68
81
|
|
|
69
82
|
Run the `help` workflow (`/bmad-help` on most platforms) to verify everything works and see what to do next.
|
|
70
83
|
|
|
71
|
-
**Latest from main branch:**
|
|
72
|
-
```bash
|
|
73
|
-
npx github:bmad-code-org/BMAD-METHOD install
|
|
74
|
-
```
|
|
75
|
-
|
|
76
|
-
Use these if you want the newest features before they're officially released. Things might break.
|
|
77
|
-
|
|
78
84
|
## Troubleshooting
|
|
79
85
|
|
|
80
86
|
**Installer throws an error** — Copy-paste the output into your AI assistant and let it figure it out.
|
|
81
87
|
|
|
82
|
-
**Installer worked but something doesn't work later** — Your AI needs BMad context to help. See [How to Get Answers About BMad](
|
|
88
|
+
**Installer worked but something doesn't work later** — Your AI needs BMad context to help. See [How to Get Answers About BMad](./get-answers-about-bmad.md) for how to point your AI at the right sources.
|