Compare commits

...

5 Commits

Author SHA1 Message Date
Brian Madison b8836ced24 another inquirer default addition missed, maybe this will fix windows issues also 2025-12-29 15:56:00 +08:00
Brian Madison c7fcf16eae fix install for alpha instruction in the readme 2025-12-29 15:45:38 +08:00
Brian Madison 529d4a8c95 doc fixes 2025-12-29 09:36:54 +08:00
Brian Madison f0520c39d9 fix wording in create-epics-and-stories doc discovery continuation 2025-12-29 09:25:56 +08:00
Brian Madison ff0517f4d0 workflow-status phase paths corrected with current reality 2025-12-29 09:25:56 +08:00
14 changed files with 177 additions and 199 deletions

3
.gitignore vendored
View File

@ -46,8 +46,6 @@ CLAUDE.local.md
# Project-specific
_bmad-core
_bmad-creator-tools
test-project-install/*
sample-project/*
flattened-codebase.xml
*.stats.md
.internal-docs/
@ -66,6 +64,7 @@ shared-modules
z*/
_bmad
_bmad-output
.claude
.codex
.github/chatmodes

View File

@ -79,13 +79,18 @@ With **BMad Builder**, you can architect both simple agents and vastly complex d
### 1. Install BMad Method
```bash
# Install v6 Alpha (recommended)
npx bmad-method install
# Install v6 RECOMMENDED
npx bmad-method@alpha install
```
# Or stable v4 for production
```bash
# Install v4 Legacy (not recommended if starting fresh)
npx bmad-method install
# OR
npx bmad-method@latest install
```
### 2. Initialize Your Project
Load any agent in your IDE and run:

View File

@ -12,8 +12,8 @@
- **[Quick Installation](./installing-bmad.md)** - Add BMad official and custom modules to a project folder.
- **[v4 to v6 Upgrade Guide](./v4-to-v6-upgrade.md)** - Migration path for v4 users
- **[Document Sharding Guide](./document-sharding-guide.md)** - Split large documents
- **[Bundle Distribution Setup](./BUNDLE_DISTRIBUTION_SETUP.md)** - (temporarily non-functional) Maintainer guide for bundle auto-publishing
- **[Document Sharding Guide](modules/core/document-sharding-guide.md)** - Split large documents
- **[Bundle Distribution Setup](../tools/docs/BUNDLE_DISTRIBUTION_SETUP.md)** - (temporarily non-functional) Maintainer guide for bundle auto-publishing
## Module Documentation
@ -81,8 +81,7 @@ AI-powered creative thinking and brainstorming.
1. [README.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/README.md) - Understand the vision
2. [Quick Start Guide](./modules/bmm-bmad-method/quick-start) - Get hands-on
3. [BMM Module README](./modules/bmm-bmad-method/) - Game agents are included
4. [BMGD Workflows Guide](./modules/bmgd/workflows-guide) - Game-specific workflows
3. [BMGD Workflows Guide](./modules/bmgd-bmad-game-dev/workflows-guide) - Game-specific workflows
### Path 3: Upgrading from v4
@ -98,9 +97,10 @@ AI-powered creative thinking and brainstorming.
### Path 5: Building Custom Solutions
1. [BMB Module Overview](./modules/bmb/index) - Understand capabilities
2. [Agent Creation Guide](./modules/bmb/agents/index) - Create agents
3. [BMB Workflows Guide](./modules/bmb/workflows/) - Understand workflow structure
1. [BMB Module Overview](./modules/bmb-bmad-builder/index) - Understand capabilities
2. [BMB Custom Content Types](./modules/bmb-bmad-builder/custom-content.md) - Understand the different types and whats possible
3. [BMB Content Installation](./modules/bmb-bmad-builder/custom-content-installation.md) - How to bundle install use and share
4. More Docs coming soon....
### Path 6: Contributing to BMad

View File

@ -90,7 +90,7 @@ Search for required documents using these patterns (sharded means a large docume
1. `{planning_artifacts}/*ux*.md` (whole document)
2. `{planning_artifacts}/*ux*/index.md` (sharded version)
Before proceeding, Ask the user if there are any other documents, or if what you have found is all there is [Yes/No]. Wait for user confirmation. Once confirmed, create the {outputFile} from the {epicsTemplate} and in the front matter list the files in the array of `inputDocuments: []`.
Before proceeding, Ask the user if there are any other documents to include for analysis, and if anything found should be excluded. Wait for user confirmation. Once confirmed, create the {outputFile} from the {epicsTemplate} and in the front matter list the files in the array of `inputDocuments: []`.
### 3. Extract Functional Requirements (FRs)

View File

@ -7,116 +7,97 @@ field_type: "brownfield"
description: "Enterprise-grade planning for complex brownfield additions with extended requirements"
phases:
- prerequisite: true
- phase: 0
name: "Documentation"
conditional: "if_undocumented"
note: "NOT a phase - prerequisite for brownfield without docs (nearly mandatory for enterprise)"
note: "Prerequisite for brownfield without docs"
workflows:
- id: "document-project"
required: true
workflow: "{project-root}/_bmad/bmm/workflows/document-project/workflow.yaml"
agent: "analyst"
command: "document-project"
command: "/bmad:bmm:workflows:document-project"
output: "Comprehensive project documentation"
purpose: "Understand existing codebase - critical for enterprise brownfield"
- phase: 0
name: "Discovery (Required)"
required: true
note: "Analysis phase required for enterprise projects"
purpose: "Understand existing codebase before planning"
- phase: 1
name: "Analysis (Optional)"
optional: true
note: "User-selected during workflow-init"
workflows:
- id: "brainstorm-project"
exec: "{project-root}/_bmad/core/workflows/brainstorming/workflow.md"
optional: true
agent: "analyst"
command: "brainstorm-project"
command: "/bmad:bmm:workflows:brainstorming"
included_by: "user_choice"
note: "Uses core brainstorming workflow with project context template"
included_by: "user_choice"
- id: "research"
recommended: true
agent: "analyst"
command: "research"
included_by: "user_choice"
note: "Highly recommended - compliance, integration, risk research"
- id: "product-brief"
exec: "{project-root}/_bmad/bmm/workflows/1-analysis/research/workflow.md"
optional: true
agent: "analyst"
command: "product-brief"
command: "/bmad:bmm:workflows:research"
included_by: "user_choice"
note: "Optional for brownfield enterprise"
- phase: 1
note: "Can have multiple research workflows"
- id: "product-brief"
exec: "{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md"
optional: true
agent: "analyst"
command: "/bmad:bmm:workflows:create-product-brief"
included_by: "user_choice"
note: "Recommended for greenfield Method projects"
- phase: 2
name: "Planning"
required: true
workflows:
- id: "prd"
exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md"
required: true
agent: "pm"
command: "prd"
output: "Enterprise PRD with compliance requirements"
note: "Must address existing system constraints and migration strategy"
command: "/bmad:bmm:workflows:create-prd"
output: "Product Requirements Document with FRs and NFRs"
- id: "create-ux-design"
recommended: true
conditional: "if_has_ui"
exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md"
agent: "ux-designer"
command: "create-ux-design"
note: "Recommended - must integrate with existing UX patterns"
- phase: 2
command: "/bmad:bmm:workflows:create-ux-design"
note: "Determined after PRD - user/agent decides if needed"
- phase: 3
name: "Solutioning"
required: true
workflows:
- id: "create-architecture"
required: true
exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md"
agent: "architect"
command: "create-architecture"
output: "Integration architecture with enterprise considerations"
note: "Distills brownfield context + adds security/scalability/compliance design"
command: "/bmad:bmm:workflows:create-architecture"
output: "System architecture document"
note: "Complete system design for greenfield projects"
- id: "create-epics-and-stories"
required: true
exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md"
agent: "pm"
command: "create-epics-and-stories"
command: "/bmad:bmm:workflows:create-epics-and-stories"
note: "Required: Break down PRD into implementable epics and stories with full context (PRD + UX + Architecture)"
- id: "test-design"
required: true
optional: true
workflow: "{project-root}/_bmad/bmm/workflows/testarch/test-design/workflow.yaml"
agent: "tea"
command: "test-design"
command: "/bmad:bmm:workflows:test-design"
output: "System-level testability review"
note: "Enterprise requires testability validation - auto-detects system-level mode"
# - id: "create-security-architecture"
# optional: true
# agent: "architect"
# command: "create-security-architecture"
# output: "Security architecture for brownfield integration"
# note: "Future workflow - optional extended enterprise workflow for threat model, auth integration, audit requirements"
# - id: "create-devops-strategy"
# optional: true
# agent: "architect"
# command: "create-devops-strategy"
# output: "DevOps strategy for brownfield deployment"
# note: "Future workflow - optional extended enterprise workflow for CI/CD integration, deployment strategy, monitoring"
- id: "validate-architecture"
recommended: true
agent: "architect"
command: "validate-architecture"
note: "Testability assessment before gate check - auto-detects system-level mode"
- id: "implementation-readiness"
required: true
exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md"
agent: "architect"
command: "implementation-readiness"
command: "/bmad:bmm:workflows:implementation-readiness"
note: "Validates PRD + Architecture + Epics + UX (optional)"
- phase: 3
- phase: 4
name: "Implementation"
required: true
workflows:
- id: "sprint-planning"
required: true
workflow: "{project-root}/_bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml"
agent: "sm"
command: "sprint-planning"
note: "Enterprise brownfield requires careful phasing and feature flags"
command: "/bmad:bmm:workflows:sprint-planning"
note: "Creates sprint plan - subsequent work tracked there"

View File

@ -7,104 +7,94 @@ field_type: "greenfield"
description: "Complete enterprise-grade planning with security, devops, and test strategy"
phases:
- phase: 0
name: "Discovery (Required)"
required: true
note: "Analysis phase required for enterprise projects"
- phase: 1
name: "Analysis (Optional)"
optional: true
note: "User-selected during workflow-init"
workflows:
- id: "brainstorm-project"
exec: "{project-root}/_bmad/core/workflows/brainstorming/workflow.md"
optional: true
agent: "analyst"
command: "brainstorm-project"
note: "Uses core brainstorming workflow with project context template"
command: "/bmad:bmm:workflows:brainstorming"
included_by: "user_choice"
note: "Uses core brainstorming workflow with project context template"
- id: "research"
recommended: true
exec: "{project-root}/_bmad/bmm/workflows/1-analysis/research/workflow.md"
optional: true
agent: "analyst"
command: "research"
command: "/bmad:bmm:workflows:research"
included_by: "user_choice"
note: "Highly recommended for enterprise - domain and compliance research"
note: "Can have multiple research workflows"
- id: "product-brief"
recommended: true
exec: "{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md"
optional: true
agent: "analyst"
command: "product-brief"
command: "/bmad:bmm:workflows:create-product-brief"
included_by: "user_choice"
note: "Recommended for strategic alignment"
note: "Recommended for greenfield Method projects"
- phase: 1
- phase: 2
name: "Planning"
required: true
workflows:
- id: "prd"
exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md"
required: true
agent: "pm"
command: "prd"
output: "Comprehensive Product Requirements Document"
note: "Enterprise-level requirements with compliance considerations"
command: "/bmad:bmm:workflows:create-prd"
output: "Product Requirements Document with FRs and NFRs"
- id: "create-ux-design"
recommended: true
conditional: "if_has_ui"
exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md"
agent: "ux-designer"
command: "create-ux-design"
note: "Highly recommended for enterprise - design system and patterns"
command: "/bmad:bmm:workflows:create-ux-design"
note: "Determined after PRD - user/agent decides if needed"
- phase: 2
- phase: 3
name: "Solutioning"
required: true
workflows:
- id: "create-architecture"
required: true
exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md"
agent: "architect"
command: "create-architecture"
output: "Enterprise-grade system architecture"
note: "Includes scalability, multi-tenancy, integration architecture"
- id: "test-design"
required: true
agent: "tea"
command: "test-design"
output: "System-level testability review"
note: "Enterprise requires testability validation - auto-detects system-level mode"
# - id: "create-security-architecture"
# optional: true
# agent: "architect"
# command: "create-security-architecture"
# output: "Security architecture and threat model"
# note: "Future workflow - optional extended enterprise workflow for security design, auth, compliance"
# - id: "create-devops-strategy"
# optional: true
# agent: "architect"
# command: "create-devops-strategy"
# output: "DevOps pipeline and infrastructure plan"
# note: "Future workflow - optional extended enterprise workflow for CI/CD, deployment, monitoring"
- id: "validate-architecture"
recommended: true
agent: "architect"
command: "validate-architecture"
command: "/bmad:bmm:workflows:create-architecture"
output: "System architecture document"
note: "Complete system design for greenfield projects"
- id: "create-epics-and-stories"
required: true
exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md"
agent: "pm"
command: "create-epics-and-stories"
command: "/bmad:bmm:workflows:create-epics-and-stories"
note: "Required: Break down PRD into implementable epics and stories with full context (PRD + UX + Architecture)"
- id: "test-design"
optional: true
workflow: "{project-root}/_bmad/bmm/workflows/testarch/test-design/workflow.yaml"
agent: "tea"
command: "/bmad:bmm:workflows:test-design"
output: "System-level testability review"
note: "Testability assessment before gate check - auto-detects system-level mode"
- id: "implementation-readiness"
required: true
exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md"
agent: "architect"
command: "implementation-readiness"
command: "/bmad:bmm:workflows:implementation-readiness"
note: "Validates PRD + Architecture + Epics + UX (optional)"
- phase: 3
- phase: 4
name: "Implementation"
required: true
workflows:
- id: "sprint-planning"
required: true
workflow: "{project-root}/_bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml"
agent: "sm"
command: "sprint-planning"
note: "Creates sprint plan - enterprise projects may require phased rollout"
command: "/bmad:bmm:workflows:sprint-planning"
note: "Creates sprint plan - subsequent work tracked there"

View File

@ -7,100 +7,97 @@ field_type: "brownfield"
description: "Complete product and system design for complex brownfield work"
phases:
- prerequisite: true
- phase: 0
name: "Documentation"
conditional: "if_undocumented"
note: "NOT a phase - prerequisite for brownfield without docs"
note: "Prerequisite for brownfield without docs"
workflows:
- id: "document-project"
required: true
workflow: "{project-root}/_bmad/bmm/workflows/document-project/workflow.yaml"
agent: "analyst"
command: "document-project"
command: "/bmad:bmm:workflows:document-project"
output: "Comprehensive project documentation"
purpose: "Understand existing codebase before planning"
- phase: 0
name: "Discovery (Optional)"
- phase: 1
name: "Analysis (Optional)"
optional: true
note: "User-selected during workflow-init"
workflows:
- id: "brainstorm-project"
exec: "{project-root}/_bmad/core/workflows/brainstorming/workflow.md"
optional: true
agent: "analyst"
command: "brainstorm-project"
command: "/bmad:bmm:workflows:brainstorming"
included_by: "user_choice"
note: "Uses core brainstorming workflow with project context template"
- id: "research"
exec: "{project-root}/_bmad/bmm/workflows/1-analysis/research/workflow.md"
optional: true
agent: "analyst"
command: "research"
command: "/bmad:bmm:workflows:research"
included_by: "user_choice"
note: "Can have multiple research workflows"
- id: "product-brief"
exec: "{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md"
optional: true
agent: "analyst"
command: "product-brief"
command: "/bmad:bmm:workflows:create-product-brief"
included_by: "user_choice"
note: "Optional for brownfield, less common than greenfield"
- phase: 1
note: "Recommended for greenfield Method projects"
- phase: 2
name: "Planning"
required: true
workflows:
- id: "prd"
exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md"
required: true
agent: "pm"
command: "prd"
output: "PRD focused on new features/changes"
note: "Must consider existing system constraints"
command: "/bmad:bmm:workflows:create-prd"
output: "Product Requirements Document with FRs and NFRs"
- id: "create-ux-design"
conditional: "if_has_ui"
exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md"
agent: "ux-designer"
command: "create-ux-design"
- phase: 2
command: "/bmad:bmm:workflows:create-ux-design"
note: "Determined after PRD - user/agent decides if needed"
- phase: 3
name: "Solutioning"
required: true
workflows:
- id: "create-architecture"
recommended: true
required: true
exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md"
agent: "architect"
command: "create-architecture"
output: "Integration architecture - solution design for THIS project"
note: "HIGHLY RECOMMENDED: Distills massive brownfield context into focused solution design. Prevents agent confusion."
command: "/bmad:bmm:workflows:create-architecture"
output: "System architecture document"
note: "Complete system design for greenfield projects"
- id: "create-epics-and-stories"
required: true
exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md"
agent: "pm"
command: "create-epics-and-stories"
command: "/bmad:bmm:workflows:create-epics-and-stories"
note: "Required: Break down PRD into implementable epics and stories with full context (PRD + UX + Architecture)"
- id: "test-design"
recommended: true
optional: true
workflow: "{project-root}/_bmad/bmm/workflows/testarch/test-design/workflow.yaml"
agent: "tea"
command: "test-design"
command: "/bmad:bmm:workflows:test-design"
output: "System-level testability review"
note: "Testability assessment before gate check - auto-detects system-level mode"
- id: "validate-architecture"
optional: true
agent: "architect"
command: "validate-architecture"
- id: "implementation-readiness"
required: true
exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md"
agent: "architect"
command: "implementation-readiness"
command: "/bmad:bmm:workflows:implementation-readiness"
note: "Validates PRD + Architecture + Epics + UX (optional)"
- phase: 3
- phase: 4
name: "Implementation"
required: true
workflows:
- id: "sprint-planning"
required: true
workflow: "{project-root}/_bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml"
agent: "sm"
command: "sprint-planning"
note: "Creates sprint plan with stories"
command: "/bmad:bmm:workflows:sprint-planning"
note: "Creates sprint plan - subsequent work tracked there"

View File

@ -7,90 +7,94 @@ field_type: "greenfield"
description: "Complete product and system design methodology for greenfield projects"
phases:
- phase: 0
name: "Discovery (Optional)"
- phase: 1
name: "Analysis (Optional)"
optional: true
note: "User-selected during workflow-init"
workflows:
- id: "brainstorm-project"
exec: "{project-root}/_bmad/core/workflows/brainstorming/workflow.md"
optional: true
agent: "analyst"
command: "brainstorm-project"
command: "/bmad:bmm:workflows:brainstorming"
included_by: "user_choice"
note: "Uses core brainstorming workflow with project context template"
- id: "research"
exec: "{project-root}/_bmad/bmm/workflows/1-analysis/research/workflow.md"
optional: true
agent: "analyst"
command: "research"
command: "/bmad:bmm:workflows:research"
included_by: "user_choice"
note: "Can have multiple research workflows"
- id: "product-brief"
exec: "{project-root}/_bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md"
optional: true
agent: "analyst"
command: "product-brief"
command: "/bmad:bmm:workflows:create-product-brief"
included_by: "user_choice"
note: "Recommended for greenfield Method projects"
- phase: 1
- phase: 2
name: "Planning"
required: true
workflows:
- id: "prd"
exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md"
required: true
agent: "pm"
command: "prd"
command: "/bmad:bmm:workflows:create-prd"
output: "Product Requirements Document with FRs and NFRs"
- id: "create-ux-design"
conditional: "if_has_ui"
exec: "{project-root}/_bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md"
agent: "ux-designer"
command: "create-ux-design"
command: "/bmad:bmm:workflows:create-ux-design"
note: "Determined after PRD - user/agent decides if needed"
- phase: 2
- phase: 3
name: "Solutioning"
required: true
workflows:
- id: "create-architecture"
required: true
exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md"
agent: "architect"
command: "create-architecture"
command: "/bmad:bmm:workflows:create-architecture"
output: "System architecture document"
note: "Complete system design for greenfield projects"
- id: "create-epics-and-stories"
required: true
exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md"
agent: "pm"
command: "create-epics-and-stories"
command: "/bmad:bmm:workflows:create-epics-and-stories"
note: "Required: Break down PRD into implementable epics and stories with full context (PRD + UX + Architecture)"
- id: "test-design"
recommended: true
optional: true
workflow: "{project-root}/_bmad/bmm/workflows/testarch/test-design/workflow.yaml"
agent: "tea"
command: "test-design"
command: "/bmad:bmm:workflows:test-design"
output: "System-level testability review"
note: "Testability assessment before gate check - auto-detects system-level mode"
- id: "validate-architecture"
optional: true
agent: "architect"
command: "validate-architecture"
note: "Quality check for architecture completeness"
- id: "implementation-readiness"
required: true
exec: "{project-root}/_bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md"
agent: "architect"
command: "implementation-readiness"
command: "/bmad:bmm:workflows:implementation-readiness"
note: "Validates PRD + Architecture + Epics + UX (optional)"
- phase: 3
- phase: 4
name: "Implementation"
required: true
workflows:
- id: "sprint-planning"
required: true
workflow: "{project-root}/_bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml"
agent: "sm"
command: "sprint-planning"
command: "/bmad:bmm:workflows:sprint-planning"
note: "Creates sprint plan - subsequent work tracked there"

View File

@ -1,6 +1,6 @@
const chalk = require('chalk');
const path = require('node:path');
const inquirer = require('inquirer');
const inquirer = require('inquirer').default || require('inquirer');
const { Installer } = require('../installers/lib/core/installer');
const { UI } = require('../lib/ui');

View File

@ -11,7 +11,7 @@ startMessage: |
IMPORTANT Changes with Version Alpha.22 - PLEASE READ THIS if upgrading from earlier Alpha Versions:
1. The BMad Core default output folder has changed from docs to `_bmad-output`. `docs`
1. The BMad Core default output folder has changed from `docs` to `_bmad-output`. `docs`
is meant for long-term artifacts, which you can always decide to move content to.
2. If utilizing the BMad Method Module (BMM) please be aware of the following important recent changes:
@ -37,7 +37,7 @@ endMessage: |
✨ BMAD IS READY TO USE!
ONE FINAL NOTE WITH VERSION Alpha.20: Phase 4 (Implementation) is still in the process of
ONE FINAL NOTE WITH VERSION Alpha.22: Phase 4 (Implementation) is still in the process of
being migrated to the improved workflow progressive disclosure system.
Along with this, the full conversion to the new path locations for content being searched
may possibly be incomplete. If you run a workflow that relies on finding input documents

2
tools/docs/index.md Normal file
View File

@ -0,0 +1,2 @@
# Tool and Repo Maintainability Documentation