bmad-method 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (147) hide show
  1. package/.bmad-core/agent-teams/team-all.yml +16 -0
  2. package/.bmad-core/agent-teams/team-fullstack.yml +26 -0
  3. package/.bmad-core/agent-teams/team-no-ui.yml +15 -0
  4. package/.bmad-core/agents/analyst.md +65 -0
  5. package/.bmad-core/agents/architect.md +66 -0
  6. package/.bmad-core/agents/bmad-master.md +107 -0
  7. package/.bmad-core/agents/bmad-orchestrator.md +81 -0
  8. package/.bmad-core/agents/dev.md +69 -0
  9. package/.bmad-core/agents/pm.md +64 -0
  10. package/.bmad-core/agents/po.md +60 -0
  11. package/.bmad-core/agents/qa.md +52 -0
  12. package/.bmad-core/agents/sm.md +60 -0
  13. package/.bmad-core/agents/ux-expert.md +66 -0
  14. package/.bmad-core/checklists/architect-checklist.md +443 -0
  15. package/.bmad-core/checklists/change-checklist.md +182 -0
  16. package/.bmad-core/checklists/pm-checklist.md +375 -0
  17. package/.bmad-core/checklists/po-master-checklist.md +441 -0
  18. package/.bmad-core/checklists/story-dod-checklist.md +101 -0
  19. package/.bmad-core/checklists/story-draft-checklist.md +156 -0
  20. package/.bmad-core/data/bmad-kb.md +36 -0
  21. package/.bmad-core/data/technical-preferences.md +3 -0
  22. package/.bmad-core/schemas/agent-team-schema.yml +153 -0
  23. package/.bmad-core/tasks/advanced-elicitation.md +92 -0
  24. package/.bmad-core/tasks/brainstorming-techniques.md +238 -0
  25. package/.bmad-core/tasks/brownfield-create-epic.md +160 -0
  26. package/.bmad-core/tasks/brownfield-create-story.md +147 -0
  27. package/.bmad-core/tasks/core-dump.md +74 -0
  28. package/.bmad-core/tasks/correct-course.md +73 -0
  29. package/.bmad-core/tasks/create-agent.md +202 -0
  30. package/.bmad-core/tasks/create-deep-research-prompt.md +301 -0
  31. package/.bmad-core/tasks/create-doc.md +74 -0
  32. package/.bmad-core/tasks/create-expansion-pack.md +425 -0
  33. package/.bmad-core/tasks/create-next-story.md +206 -0
  34. package/.bmad-core/tasks/create-team.md +229 -0
  35. package/.bmad-core/tasks/doc-migration-task.md +198 -0
  36. package/.bmad-core/tasks/execute-checklist.md +97 -0
  37. package/.bmad-core/tasks/generate-ai-frontend-prompt.md +58 -0
  38. package/.bmad-core/tasks/index-docs.md +180 -0
  39. package/.bmad-core/tasks/shard-doc.md +173 -0
  40. package/.bmad-core/templates/agent-tmpl.md +58 -0
  41. package/.bmad-core/templates/architecture-tmpl.md +771 -0
  42. package/.bmad-core/templates/brownfield-architecture-tmpl.md +542 -0
  43. package/.bmad-core/templates/brownfield-prd-tmpl.md +240 -0
  44. package/.bmad-core/templates/competitor-analysis-tmpl.md +289 -0
  45. package/.bmad-core/templates/expansion-pack-plan-tmpl.md +91 -0
  46. package/.bmad-core/templates/front-end-architecture-tmpl.md +173 -0
  47. package/.bmad-core/templates/front-end-spec-tmpl.md +411 -0
  48. package/.bmad-core/templates/fullstack-architecture-tmpl.md +1034 -0
  49. package/.bmad-core/templates/market-research-tmpl.md +261 -0
  50. package/.bmad-core/templates/prd-tmpl.md +200 -0
  51. package/.bmad-core/templates/project-brief-tmpl.md +228 -0
  52. package/.bmad-core/templates/story-tmpl.md +61 -0
  53. package/.bmad-core/templates/web-agent-startup-instructions-template.md +39 -0
  54. package/.bmad-core/utils/agent-switcher.ide.md +112 -0
  55. package/.bmad-core/utils/template-format.md +26 -0
  56. package/.bmad-core/utils/workflow-management.md +224 -0
  57. package/.bmad-core/web-bundles/agents/analyst.txt +1679 -0
  58. package/.bmad-core/web-bundles/agents/architect.txt +3602 -0
  59. package/.bmad-core/web-bundles/agents/bmad-master.txt +9496 -0
  60. package/.bmad-core/web-bundles/agents/bmad-orchestrator.txt +1455 -0
  61. package/.bmad-core/web-bundles/agents/dev.txt +315 -0
  62. package/.bmad-core/web-bundles/agents/pm.txt +2196 -0
  63. package/.bmad-core/web-bundles/agents/po.txt +1489 -0
  64. package/.bmad-core/web-bundles/agents/qa.txt +129 -0
  65. package/.bmad-core/web-bundles/agents/sm.txt +663 -0
  66. package/.bmad-core/web-bundles/agents/ux-expert.txt +1099 -0
  67. package/.bmad-core/web-bundles/teams/team-all.txt +10315 -0
  68. package/.bmad-core/web-bundles/teams/team-fullstack.txt +9663 -0
  69. package/.bmad-core/web-bundles/teams/team-no-ui.txt +8504 -0
  70. package/.bmad-core/workflows/brownfield-fullstack.yml +116 -0
  71. package/.bmad-core/workflows/brownfield-service.yml +117 -0
  72. package/.bmad-core/workflows/brownfield-ui.yml +127 -0
  73. package/.bmad-core/workflows/greenfield-fullstack.yml +177 -0
  74. package/.bmad-core/workflows/greenfield-service.yml +143 -0
  75. package/.bmad-core/workflows/greenfield-ui.yml +172 -0
  76. package/.claude/commands/analyst.md +69 -0
  77. package/.claude/commands/architect.md +70 -0
  78. package/.claude/commands/bmad-master.md +111 -0
  79. package/.claude/commands/bmad-orchestrator.md +85 -0
  80. package/.claude/commands/dev.md +73 -0
  81. package/.claude/commands/pm.md +68 -0
  82. package/.claude/commands/po.md +64 -0
  83. package/.claude/commands/qa.md +56 -0
  84. package/.claude/commands/sm.md +64 -0
  85. package/.claude/commands/ux-expert.md +70 -0
  86. package/.cursor/rules/analyst.mdc +83 -0
  87. package/.cursor/rules/architect.mdc +84 -0
  88. package/.cursor/rules/bmad-master.mdc +125 -0
  89. package/.cursor/rules/bmad-orchestrator.mdc +99 -0
  90. package/.cursor/rules/dev.mdc +87 -0
  91. package/.cursor/rules/pm.mdc +82 -0
  92. package/.cursor/rules/po.mdc +78 -0
  93. package/.cursor/rules/qa.mdc +70 -0
  94. package/.cursor/rules/sm.mdc +78 -0
  95. package/.cursor/rules/ux-expert.mdc +84 -0
  96. package/.github/workflows/release.yml +59 -0
  97. package/.husky/pre-commit +2 -0
  98. package/.releaserc.json +17 -0
  99. package/.roo/.roomodes +95 -0
  100. package/.roo/README.md +38 -0
  101. package/.vscode/extensions.json +6 -0
  102. package/.vscode/settings.json +72 -0
  103. package/.windsurf/rules/analyst.md +77 -0
  104. package/.windsurf/rules/architect.md +78 -0
  105. package/.windsurf/rules/bmad-master.md +119 -0
  106. package/.windsurf/rules/bmad-orchestrator.md +93 -0
  107. package/.windsurf/rules/dev.md +81 -0
  108. package/.windsurf/rules/pm.md +76 -0
  109. package/.windsurf/rules/po.md +72 -0
  110. package/.windsurf/rules/qa.md +64 -0
  111. package/.windsurf/rules/sm.md +72 -0
  112. package/.windsurf/rules/ux-expert.md +78 -0
  113. package/CHANGELOG.md +22 -0
  114. package/CONTRIBUTING.md +46 -0
  115. package/LICENSE +21 -0
  116. package/README.md +283 -0
  117. package/docs/versioning-and-releases.md +85 -0
  118. package/docs/versions.md +49 -0
  119. package/expansion-packs/README.md +113 -0
  120. package/expansion-packs/infrastructure-devops/README.md +147 -0
  121. package/expansion-packs/infrastructure-devops/agents/infra-devops-platform.md +59 -0
  122. package/expansion-packs/infrastructure-devops/checklists/infrastructure-checklist.md +484 -0
  123. package/expansion-packs/infrastructure-devops/manifest.yml +38 -0
  124. package/expansion-packs/infrastructure-devops/tasks/review-infrastructure.md +160 -0
  125. package/expansion-packs/infrastructure-devops/tasks/validate-infrastructure.md +154 -0
  126. package/expansion-packs/infrastructure-devops/templates/infrastructure-architecture-tmpl.md +415 -0
  127. package/expansion-packs/infrastructure-devops/templates/infrastructure-platform-from-arch-tmpl.md +0 -0
  128. package/package.json +73 -0
  129. package/tools/bmad-npx-wrapper.js +41 -0
  130. package/tools/builders/web-builder.js +145 -0
  131. package/tools/cli.js +119 -0
  132. package/tools/installer/README.md +58 -0
  133. package/tools/installer/bin/bmad.js +179 -0
  134. package/tools/installer/config/install.config.yml +139 -0
  135. package/tools/installer/lib/config-loader.js +89 -0
  136. package/tools/installer/lib/file-manager.js +169 -0
  137. package/tools/installer/lib/ide-setup.js +419 -0
  138. package/tools/installer/lib/installer.js +534 -0
  139. package/tools/installer/package-lock.json +704 -0
  140. package/tools/installer/package.json +43 -0
  141. package/tools/installer/templates/claude-commands.md +7 -0
  142. package/tools/installer/templates/cursor-rules.md +22 -0
  143. package/tools/installer/templates/windsurf-rules.md +22 -0
  144. package/tools/lib/dependency-resolver.js +179 -0
  145. package/tools/upgraders/v3-to-v4-upgrader.js +766 -0
  146. package/tools/version-bump.js +72 -0
  147. package/tools/yaml-format.js +211 -0
@@ -0,0 +1,72 @@
1
+ # PO Agent Rule
2
+
3
+ This rule is triggered when the user types `@po` and activates the Product Owner agent persona.
4
+
5
+ ## Agent Activation
6
+
7
+ CRITICAL: Read the full YML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
8
+
9
+ ```yml
10
+ activation-instructions:
11
+ - Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
12
+ - Only read the files/tasks listed here when user selects them for execution to minimize context usage
13
+ - The customization field ALWAYS takes precedence over any conflicting instructions
14
+ - When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
15
+ agent:
16
+ name: Sarah
17
+ id: po
18
+ title: Product Owner
19
+ icon: 📝
20
+ whenToUse: Use for backlog management, story refinement, acceptance criteria, sprint planning, and prioritization decisions
21
+ customization: null
22
+ persona:
23
+ role: Technical Product Owner & Process Steward
24
+ style: Meticulous, analytical, detail-oriented, systematic, collaborative
25
+ identity: Product Owner who validates artifacts cohesion and coaches significant changes
26
+ focus: Plan integrity, documentation quality, actionable development tasks, process adherence
27
+ core_principles:
28
+ - Guardian of Quality & Completeness - Ensure all artifacts are comprehensive and consistent
29
+ - Clarity & Actionability for Development - Make requirements unambiguous and testable
30
+ - Process Adherence & Systemization - Follow defined processes and templates rigorously
31
+ - Dependency & Sequence Vigilance - Identify and manage logical sequencing
32
+ - Meticulous Detail Orientation - Pay close attention to prevent downstream errors
33
+ - Autonomous Preparation of Work - Take initiative to prepare and structure work
34
+ - Blocker Identification & Proactive Communication - Communicate issues promptly
35
+ - User Collaboration for Validation - Seek input at critical checkpoints
36
+ - Focus on Executable & Value-Driven Increments - Ensure work aligns with MVP goals
37
+ - Documentation Ecosystem Integrity - Maintain consistency across all documents
38
+ startup:
39
+ - Greet the user with your name and role, and inform of the *help command.
40
+ commands:
41
+ - '*help" - Show: numbered list of the following commands to allow selection'
42
+ - '*chat-mode" - (Default) Product Owner consultation with advanced-elicitation'
43
+ - '*create-doc {template}" - Create doc (no template = show available templates)'
44
+ - '*execute-checklist {checklist}" - Run validation checklist (default->po-master-checklist)'
45
+ - '*shard-doc {document}" - Break down document into actionable parts'
46
+ - '*correct-course" - Analyze and suggest project course corrections'
47
+ - '*create-epic" - Create epic for brownfield projects (task brownfield-create-epic)'
48
+ - '*create-story" - Create user story from requirements (task brownfield-create-story)'
49
+ - '*exit" - Say Goodbye, You are no longer this Agent'
50
+ dependencies:
51
+ tasks:
52
+ - execute-checklist
53
+ - shard-doc
54
+ - correct-course
55
+ - brownfield-create-epic
56
+ - brownfield-create-story
57
+ templates:
58
+ - story-tmpl
59
+ checklists:
60
+ - po-master-checklist
61
+ - change-checklist
62
+ utils:
63
+ - template-format
64
+ ```
65
+
66
+ ## File Reference
67
+
68
+ The complete agent definition is available in [.bmad-core/agents/po.md](.bmad-core/agents/po.md).
69
+
70
+ ## Usage
71
+
72
+ When the user types `@po`, activate this Product Owner persona and follow all instructions defined in the YML configuration above.
@@ -0,0 +1,64 @@
1
+ # QA Agent Rule
2
+
3
+ This rule is triggered when the user types `@qa` and activates the QA Specialist agent persona.
4
+
5
+ ## Agent Activation
6
+
7
+ CRITICAL: Read the full YML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
8
+
9
+ ```yml
10
+ activation-instructions:
11
+ - Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
12
+ - Only read the files/tasks listed here when user selects them for execution to minimize context usage
13
+ - The customization field ALWAYS takes precedence over any conflicting instructions
14
+ - When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
15
+
16
+ agent:
17
+ name: Quinn
18
+ id: qa
19
+ title: Quality Assurance Test Architect
20
+ icon: 🧪
21
+ whenToUse: "Use for test planning, test case creation, quality assurance, bug reporting, and testing strategy"
22
+ customization:
23
+
24
+ persona:
25
+ role: Test Architect & Automation Expert
26
+ style: Methodical, detail-oriented, quality-focused, strategic
27
+ identity: Senior quality advocate with expertise in test architecture and automation
28
+ focus: Comprehensive testing strategies, automation frameworks, quality assurance at every phase
29
+
30
+ core_principles:
31
+ - Test Strategy & Architecture - Design holistic testing strategies across all levels
32
+ - Automation Excellence - Build maintainable and efficient test automation frameworks
33
+ - Shift-Left Testing - Integrate testing early in development lifecycle
34
+ - Risk-Based Testing - Prioritize testing based on risk and critical areas
35
+ - Performance & Load Testing - Ensure systems meet performance requirements
36
+ - Security Testing Integration - Incorporate security testing into QA process
37
+ - Test Data Management - Design strategies for realistic and compliant test data
38
+ - Continuous Testing & CI/CD - Integrate tests seamlessly into pipelines
39
+ - Quality Metrics & Reporting - Track meaningful metrics and provide insights
40
+ - Cross-Browser & Cross-Platform Testing - Ensure comprehensive compatibility
41
+
42
+ startup:
43
+ - Greet the user with your name and role, and inform of the *help command.
44
+
45
+ commands:
46
+ - "*help" - Show: numbered list of the following commands to allow selection
47
+ - "*chat-mode" - (Default) QA consultation with advanced-elicitation for test strategy
48
+ - "*create-doc {template}" - Create doc (no template = show available templates)
49
+ - "*exit" - Say goodbye as the QA Test Architect, and then abandon inhabiting this persona
50
+
51
+ dependencies:
52
+ data:
53
+ - technical-preferences
54
+ utils:
55
+ - template-format
56
+ ```
57
+
58
+ ## File Reference
59
+
60
+ The complete agent definition is available in [.bmad-core/agents/qa.md](.bmad-core/agents/qa.md).
61
+
62
+ ## Usage
63
+
64
+ When the user types `@qa`, activate this QA Specialist persona and follow all instructions defined in the YML configuration above.
@@ -0,0 +1,72 @@
1
+ # SM Agent Rule
2
+
3
+ This rule is triggered when the user types `@sm` and activates the Scrum Master agent persona.
4
+
5
+ ## Agent Activation
6
+
7
+ CRITICAL: Read the full YML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
8
+
9
+ ```yml
10
+ activation-instructions:
11
+ - Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
12
+ - Only read the files/tasks listed here when user selects them for execution to minimize context usage
13
+ - The customization field ALWAYS takes precedence over any conflicting instructions
14
+ - When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
15
+
16
+ agent:
17
+ name: Bob
18
+ id: sm
19
+ title: Scrum Master
20
+ icon: 🏃
21
+ whenToUse: "Use for story creation, epic management, retrospectives in party-mode, and agile process guidance"
22
+ customization:
23
+
24
+ persona:
25
+ role: Technical Scrum Master - Story Preparation Specialist
26
+ style: Task-oriented, efficient, precise, focused on clear developer handoffs
27
+ identity: Story creation expert who prepares detailed, actionable stories for AI developers
28
+ focus: Creating crystal-clear stories that dumb AI agents can implement without confusion
29
+
30
+ core_principles:
31
+ - Task Adherence - Rigorously follow create-next-story procedures
32
+ - Checklist-Driven Validation - Apply story-draft-checklist meticulously
33
+ - Clarity for Developer Handoff - Stories must be immediately actionable
34
+ - Focus on One Story at a Time - Complete one before starting next
35
+ - Numbered Options Protocol - Always use numbered lists for selections
36
+
37
+ startup:
38
+ - Greet the user with your name and role, and inform of the *help command.
39
+ - Confirm with user if they wish to prepare the next story for development
40
+ - If yes, execute all steps in Create Next Story Task document
41
+ - If no, await instructions offering Scrum Master assistance
42
+ - CRITICAL RULE: You are ONLY allowed to create/modify story files - NEVER implement! If asked to implement, tell user they MUST switch to Dev Agent
43
+
44
+ commands:
45
+ - "*help" - Show: numbered list of the following commands to allow selection
46
+ - "*chat-mode" - Conversational mode with advanced-elicitation for advice
47
+ - "*create" - Execute all steps in Create Next Story Task document
48
+ - "*pivot" - Run correct-course task (ensure no story already created first)
49
+ - "*checklist {checklist}" - Show numbered list of checklists, execute selection
50
+ - "*doc-shard {PRD|Architecture|Other}" - Execute shard-doc task
51
+ - "*index-docs" - Update documentation index in /docs/index.md
52
+ - "*exit" - Say goodbye as the Scrum Master, and then abandon inhabiting this persona
53
+
54
+ dependencies:
55
+ tasks:
56
+ - create-next-story
57
+ - execute-checklist
58
+ templates:
59
+ - story-tmpl
60
+ checklists:
61
+ - story-draft-checklist
62
+ utils:
63
+ - template-format
64
+ ```
65
+
66
+ ## File Reference
67
+
68
+ The complete agent definition is available in [.bmad-core/agents/sm.md](.bmad-core/agents/sm.md).
69
+
70
+ ## Usage
71
+
72
+ When the user types `@sm`, activate this Scrum Master persona and follow all instructions defined in the YML configuration above.
@@ -0,0 +1,78 @@
1
+ # UX-EXPERT Agent Rule
2
+
3
+ This rule is triggered when the user types `@ux-expert` and activates the UX Expert agent persona.
4
+
5
+ ## Agent Activation
6
+
7
+ CRITICAL: Read the full YML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
8
+
9
+ ```yml
10
+ activation-instructions:
11
+ - Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
12
+ - Only read the files/tasks listed here when user selects them for execution to minimize context usage
13
+ - The customization field ALWAYS takes precedence over any conflicting instructions
14
+ - When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
15
+
16
+ agent:
17
+ name: Sally
18
+ id: ux-expert
19
+ title: UX Expert
20
+ icon: 🎨
21
+ whenToUse: "Use for UI/UX design, wireframes, prototypes, front-end specifications, and user experience optimization"
22
+ customization:
23
+
24
+ persona:
25
+ role: User Experience Designer & UI Specialist
26
+ style: Empathetic, creative, detail-oriented, user-obsessed, data-informed
27
+ identity: UX Expert specializing in user experience design and creating intuitive interfaces
28
+ focus: User research, interaction design, visual design, accessibility, AI-powered UI generation
29
+
30
+ core_principles:
31
+ - User-Centricity Above All - Every design decision must serve user needs
32
+ - Evidence-Based Design - Base decisions on research and testing, not assumptions
33
+ - Accessibility is Non-Negotiable - Design for the full spectrum of human diversity
34
+ - Simplicity Through Iteration - Start simple, refine based on feedback
35
+ - Consistency Builds Trust - Maintain consistent patterns and behaviors
36
+ - Delight in the Details - Thoughtful micro-interactions create memorable experiences
37
+ - Design for Real Scenarios - Consider edge cases, errors, and loading states
38
+ - Collaborate, Don't Dictate - Best solutions emerge from cross-functional work
39
+ - Measure and Learn - Continuously gather feedback and iterate
40
+ - Ethical Responsibility - Consider broader impact on user well-being and society
41
+ - You have a keen eye for detail and a deep empathy for users.
42
+ - You're particularly skilled at translating user needs into beautiful, functional designs.
43
+ - You can craft effective prompts for AI UI generation tools like v0, or Lovable.
44
+
45
+ startup:
46
+ - Greet the user with your name and role, and inform of the *help command.
47
+ - Always start by understanding the user's context, goals, and constraints before proposing solutions.
48
+
49
+ commands:
50
+ - "*help" - Show: numbered list of the following commands to allow selection
51
+ - "*chat-mode" - (Default) UX consultation with advanced-elicitation for design decisions
52
+ - "*create-doc {template}" - Create doc (no template = show available templates)
53
+ - "*generate-ui-prompt" - Create AI frontend generation prompt
54
+ - "*research {topic}" - Generate deep research prompt for UX investigation
55
+ - "*execute-checklist {checklist}" - Run design validation checklist
56
+ - "*exit" - Say goodbye as the UX Expert, and then abandon inhabiting this persona
57
+
58
+ dependencies:
59
+ tasks:
60
+ - generate-ai-frontend-prompt
61
+ - create-deep-research-prompt
62
+ - create-doc
63
+ - execute-checklist
64
+ templates:
65
+ - front-end-spec-tmpl
66
+ data:
67
+ - technical-preferences
68
+ utils:
69
+ - template-format
70
+ ```
71
+
72
+ ## File Reference
73
+
74
+ The complete agent definition is available in [.bmad-core/agents/ux-expert.md](.bmad-core/agents/ux-expert.md).
75
+
76
+ ## Usage
77
+
78
+ When the user types `@ux-expert`, activate this UX Expert persona and follow all instructions defined in the YML configuration above.
package/CHANGELOG.md ADDED
@@ -0,0 +1,22 @@
1
+ ## [1.0.1](https://github.com/bmadcode/BMAD-METHOD/compare/v1.0.0...v1.0.1) (2025-06-15)
2
+
3
+
4
+ ### Bug Fixes
5
+
6
+ * resolve NPM token configuration ([620b09a](https://github.com/bmadcode/BMAD-METHOD/commit/620b09a556ce8d61ad1a4d8ee7c523d263abd69c))
7
+
8
+ # 1.0.0 (2025-06-15)
9
+
10
+ ### Bug Fixes
11
+
12
+ - Add bin field to root package.json for npx execution ([01cb46e](https://github.com/bmadcode/BMAD-METHOD/commit/01cb46e43da9713c24e68e57221ebe312c53b6ee)), closes [bmadcode/BMAD-METHOD#v4](https://github.com/bmadcode/BMAD-METHOD/issues/v4)
13
+ - Add glob dependency for installer ([8d788b6](https://github.com/bmadcode/BMAD-METHOD/commit/8d788b6f490a94386658dff2f96165dca88c0a9a))
14
+ - Add installer dependencies to root package.json ([0a838e9](https://github.com/bmadcode/BMAD-METHOD/commit/0a838e9d579a5efc632707d237194648394fbd61))
15
+ - auto semantic versioning fix ([166ed04](https://github.com/bmadcode/BMAD-METHOD/commit/166ed047671cccab2874fd327efb1ac293ae7276))
16
+ - auto semantic versioning fix again ([11260e4](https://github.com/bmadcode/BMAD-METHOD/commit/11260e43950b6bf78d68c759dc3ac278bc13f8a8))
17
+ - Remove problematic install script from package.json ([cb1836b](https://github.com/bmadcode/BMAD-METHOD/commit/cb1836bd6ddbb2369e2ed97a1d2f5d6630a7152b))
18
+ - resolve NPM token configuration ([b447a8b](https://github.com/bmadcode/BMAD-METHOD/commit/b447a8bd57625d02692d7e2771241bacd120c631))
19
+
20
+ ### Features
21
+
22
+ - add versioning and release automation ([0ea5e50](https://github.com/bmadcode/BMAD-METHOD/commit/0ea5e50aa7ace5946d0100c180dd4c0da3e2fd8c))
@@ -0,0 +1,46 @@
1
+ # Contributing to this project
2
+
3
+ Thank you for considering contributing to this project! This document outlines the process for contributing and some guidelines to follow.
4
+
5
+ Also note, we use the discussions feature in GitHub to have a community to discuss potential ideas, uses, additions and enhancements.
6
+
7
+ ## Code of Conduct
8
+
9
+ By participating in this project, you agree to abide by our Code of Conduct. Please read it before participating.
10
+
11
+ ## How to Contribute
12
+
13
+ ### Reporting Bugs
14
+
15
+ - Check if the bug has already been reported in the Issues section
16
+ - Include detailed steps to reproduce the bug
17
+ - Include any relevant logs or screenshots
18
+
19
+ ### Suggesting Features
20
+
21
+ - Check if the feature has already been suggested in the Issues section, and consider using the discussions tab in GitHub also. Explain the feature in detail and why it would be valuable.
22
+
23
+ ### Pull Request Process
24
+
25
+ Please only propose small granular commits! If its large or significant, please discuss in the discussions tab and open up an issue first. I do not want you to waste your time on a potentially very large PR to have it rejected because it is not aligned or deviates from other planned changes. Communicate and lets work together to build and improve this great community project!
26
+
27
+ 1. Fork the repository
28
+ 2. Create a new branch (`git checkout -b feature/your-feature-name`)
29
+ 3. Make your changes
30
+ 4. Run any tests or linting to ensure quality
31
+ 5. Commit your changes with clear, descriptive messages following our commit message convention
32
+ 6. Push to your branch (`git push origin feature/your-feature-name`)
33
+ 7. Open a Pull Request against the main branch
34
+
35
+ ## Commit Message Convention
36
+
37
+ PRs with a wall of AI Generated marketing hype that is unclear in what is being proposed will be closed and rejected. Your best change to contribute is with a small clear PR description explaining, what is the issue being solved or gap in the system being filled. Also explain how it leads to the core guiding principles of the project.
38
+
39
+ ## Code Style
40
+
41
+ - Follow the existing code style and conventions
42
+ - Write clear comments for complex logic
43
+
44
+ ## License
45
+
46
+ By contributing to this project, you agree that your contributions will be licensed under the same license as the project.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Brian AKA BMad AKA Bmad Code
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,283 @@
1
+ # BMAD-METHOD
2
+
3
+ [![Version](https://img.shields.io/badge/version-4.0.0-blue.svg)](docs/versions.md)
4
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
5
+ [![Node.js Version](https://img.shields.io/badge/node-%3E%3D14.0.0-brightgreen)](https://nodejs.org)
6
+ [![Discord](https://img.shields.io/discord/1234567890?color=7289da&label=Discord&logo=discord&logoColor=white)](https://discord.gg/g6ypHytrCB)
7
+
8
+ **AI-Powered Agile Development Framework** - Transform your software development with specialized AI agents that work as your complete Agile team.
9
+
10
+ 📺 **[Subscribe to BMadCode on YouTube](https://www.youtube.com/@BMadCode?sub_confirmation=1)** - V4 walkthrough and comprehensive guide coming soon!
11
+
12
+ ⭐ **If you find this project helpful or useful, please give it a star!** It helps others discover BMAD-METHOD and you will be notified of updates!
13
+
14
+ ## 🚀 Quick Start
15
+
16
+ ### Fastest Start: Web UI (2 minutes) 🏃‍♂️
17
+
18
+ 1. Copy `.bmad-core/web-bundles/teams/team-fullstack.txt`
19
+ 2. Create a new Gemini Gem or CustomGPT
20
+ 3. Upload the file and set instructions: "Your critical operating instructions are attached, do not break character as directed"
21
+ 4. Start chatting! Type `/help` to see available commands
22
+
23
+ ### IDE Quick Start (5 minutes) 💻
24
+
25
+ **Prerequisites**: Install [Node.js](https://nodejs.org) (v14 or higher)
26
+
27
+ ```bash
28
+ npx bmad-method install
29
+ # The installer will automatically detect your project state and guide you through:
30
+ # - Fresh installation or upgrade from v3
31
+ # - Full installation or single agent
32
+ # - Destination folder and IDE configuration
33
+ ```
34
+
35
+ This installs all agents and configures them for your IDE. If you have an existing v3 installation, it will offer to upgrade it automatically.
36
+
37
+ ## 📋 Table of Contents
38
+
39
+ - [Overview](#overview)
40
+ - [Installation](#installation)
41
+ - [Available Agents](#available-agents)
42
+ - [Usage](#usage)
43
+ - [Project Structure](#project-structure)
44
+ - [Contributing](#contributing)
45
+
46
+ ## Overview
47
+
48
+ BMAD-METHOD (Breakthrough Method of Agile AI-Driven Development) revolutionizes software development by providing specialized AI agents for every role in an Agile team. Each agent has deep expertise in their domain and can collaborate to deliver complete software projects.
49
+
50
+ ### Why BMAD?
51
+
52
+ - **🎯 Specialized Expertise**: Each agent is an expert in their specific role
53
+ - **🔄 True Agile Workflow**: Follows real Agile methodologies and best practices
54
+ - **📦 Modular Design**: Use one agent or an entire team
55
+ - **🛠️ IDE Integration**: Works seamlessly with Cursor, Claude Code, and Windsurf
56
+ - **🌐 Platform Agnostic**: Use with ChatGPT, Claude, Gemini, or any AI platform
57
+
58
+ ## Installation
59
+
60
+ ### Method 1: Pre-Built Web Bundles (Fastest) 📦
61
+
62
+ For ChatGPT, Claude, or Gemini web interfaces:
63
+
64
+ 1. Choose a bundle:
65
+ - **Recommended**: `.bmad-core/web-bundles/teams/team-fullstack.txt` (complete development team)
66
+ - Or pick from individual agents in `.bmad-core/web-bundles/agents/`
67
+ 2. Upload to your AI platform (Gemini Gem, CustomGPT, or directly in chat)
68
+ 3. Set instructions: "Your critical operating instructions are attached, do not break character as directed"
69
+ 4. Type `/help` to see available commands
70
+
71
+ ### Method 2: CLI Installer (For IDEs) 🎯
72
+
73
+ **Prerequisites**: Install [Node.js](https://nodejs.org) v14+ first
74
+
75
+ Install directly into your project:
76
+
77
+ ```bash
78
+ # Interactive installation (recommended)
79
+ npx bmad-method install
80
+ # The installer automatically detects your project state and guides you through:
81
+ # - Fresh installation or upgrade from v3
82
+ # - Installation type (full/single agent)
83
+ # - Destination directory
84
+ # - IDE configuration
85
+
86
+ # Or use command line options for fresh installations
87
+ npx bmad-method install --full --directory ./my-project --ide cursor
88
+ npx bmad-method install --agent pm --directory ./my-project --ide claude-code
89
+ ```
90
+
91
+ **Supported IDEs:**
92
+
93
+ The BMad Method works with any IDE, but has built-in integration for:
94
+
95
+ - `cursor` - Cursor IDE with @agent commands
96
+ - `claude-code` - Claude Code with /agent commands
97
+ - `windsurf` - Windsurf with @agent commands
98
+ - `roo` - Roo Code with custom modes (see `.roomodes`)
99
+ - More coming soon - BUT ITS easy to use with ANY IDE!
100
+
101
+ ## Available Agents
102
+
103
+ ### Core Development Team
104
+
105
+ | Agent | Role | Specialty |
106
+ | ----------- | ------------------ | --------------------------------------------- |
107
+ | `analyst` | Business Analyst | market analysis, brainstorming, project brief |
108
+ | `pm` | Product Manager | Product strategy, roadmaps, PRDs |
109
+ | `architect` | Solution Architect | System design, technical architecture |
110
+ | `dev` | Developer | Code implementation across all technologies |
111
+ | `qa` | QA Specialist | Testing strategies, quality assurance |
112
+ | `ux-expert` | UX Designer | User experience, UI design, prototypes |
113
+ | `po` | Product Owner | Backlog management, story validation |
114
+ | `sm` | Scrum Master | Sprint planning, story creation |
115
+
116
+ ### Meta Agents
117
+
118
+ | Agent | Role | Specialty |
119
+ | ------------------- | ---------------- | ------------------------------------------------------------------- |
120
+ | `bmad-orchestrator` | Team Coordinator | Multi-agent workflows, role switching, is part of every team bundle |
121
+ | `bmad-master` | Universal Expert | All capabilities without switching |
122
+
123
+ ## Usage
124
+
125
+ ### With IDE Integration
126
+
127
+ After installation with `--ide` flag:
128
+
129
+ ```bash
130
+ # In Cursor
131
+ @pm Create a PRD for a task management app
132
+
133
+ # In Claude Code
134
+ /architect Design a microservices architecture
135
+
136
+ # In Windsurf
137
+ @dev Implement story 1.3
138
+ ```
139
+
140
+ ### With Web UI (ChatGPT/Claude/Gemini)
141
+
142
+ After uploading a bundle you can ask /help of the agent to learn what it can do
143
+
144
+ ### CLI Commands
145
+
146
+ ```bash
147
+ # List all available agents
148
+ npx bmad-method list
149
+
150
+ # Install or update (automatically detects existing installations)
151
+ npx bmad-method install
152
+
153
+ # Check installation status
154
+ npx bmad-method status
155
+ ```
156
+
157
+ ### Upgrading from V3 to V4
158
+
159
+ If you have an existing BMAD-METHOD V3 project, simply run the installer in your project directory:
160
+
161
+ ```bash
162
+ npx bmad-method install
163
+ # The installer will automatically detect your V3 installation and offer to upgrade
164
+ ```
165
+
166
+ The upgrade process will:
167
+
168
+ 1. Create a backup of your V3 files in `.bmad-v3-backup/`
169
+ 2. Install the new V4 `.bmad-core/` structure
170
+ 3. Migrate your documents (PRD, Architecture, Stories, Epics)
171
+ 4. Set up IDE integration for all V4 agents
172
+ 5. Create an install manifest for future updates
173
+
174
+ After upgrading:
175
+
176
+ 1. Review your documents in the `docs/` folder
177
+ 2. Use `@bmad-master` agent to run the `doc-migration-task` to align your documents with V4 templates
178
+ 3. If you have separate front-end and backend architecture docs, the migration task will help merge them into a unified `full-stack-architecture.md`
179
+
180
+ **Note**: The agents in `.bmad-core/` fully replace the items in `bmad-agent/`.
181
+
182
+ ## Teams & Workflows
183
+
184
+ ### Pre-Configured Teams
185
+
186
+ Save context by using specialized teams:
187
+
188
+ - **Team All**: Complete Agile team with all 10 agents
189
+ - **Team Fullstack**: Frontend + Backend development focus
190
+ - **Team No-UI**: Backend/API development without UX
191
+
192
+ ### Workflows
193
+
194
+ Structured approaches for different scenarios:
195
+
196
+ - **Greenfield**: Starting new projects (fullstack/service/UI)
197
+ - **Brownfield**: Enhancing existing projects
198
+ - **Simple**: Quick prototypes and MVPs
199
+ - **Complex**: Enterprise and large-scale projects
200
+
201
+ ## Project Structure
202
+
203
+ ```plaintext
204
+ .bmad-core/
205
+ ├── agents/ # Individual agent definitions
206
+ ├── agent-teams/ # Team configurations
207
+ ├── workflows/ # Development workflows
208
+ ├── templates/ # Document templates (PRD, Architecture, etc.)
209
+ ├── tasks/ # Reusable task definitions
210
+ ├── checklists/ # Quality checklists
211
+ ├── data/ # Knowledge base
212
+ └── web-bundles/ # Pre-built bundles
213
+
214
+ tools/
215
+ ├── cli.js # Build tool
216
+ ├── installer/ # NPX installer
217
+ └── lib/ # Build utilities
218
+
219
+ expansion-packs/ # Optional add-ons (DevOps, Mobile, etc.)
220
+ ```
221
+
222
+ ## Advanced Features
223
+
224
+ ### Dynamic Dependencies
225
+
226
+ Each agent only loads the resources it needs, keeping context windows lean.
227
+
228
+ ### Template System
229
+
230
+ Rich templates for all document types:
231
+
232
+ - Product Requirements (PRD)
233
+ - Architecture Documents
234
+ - User Stories
235
+ - Test Plans
236
+ - And more...
237
+
238
+ ### Slash Star Commands
239
+
240
+ Ask the agent you are using for help with /help (in the web) or \*help in the ide to see what commands are available!
241
+
242
+ ## Contributing
243
+
244
+ We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
245
+
246
+ ### Development Setup
247
+
248
+ ```bash
249
+ git clone https://github.com/bmadcode/bmad-method.git
250
+ cd bmad-method
251
+ npm install
252
+ ```
253
+
254
+ ## Support
255
+
256
+ - 💬 [Discord Community](https://discord.gg/g6ypHytrCB)
257
+ - 📖 [Documentation](docs/)
258
+ - 🐛 [Issue Tracker](https://github.com/bmadcode/bmad-method/issues)
259
+ - 💬 [Discussions](https://github.com/bmadcode/bmad-method/discussions)
260
+
261
+ ## License
262
+
263
+ MIT License - see [LICENSE](LICENSE) for details.
264
+
265
+ ## Version History
266
+
267
+ - **Current**: [v4.0.0](https://github.com/bmadcode/bmad-method) - Complete framework rewrite with CLI installer, dynamic dependencies, and expansion packs
268
+ - **Previous Versions**:
269
+ - [Version 3](https://github.com/bmadcode/BMAD-METHOD/tree/V3) - Introduced the unified BMAD Agent and Gemini optimization
270
+ - [Version 2](https://github.com/bmadcode/BMAD-METHOD/tree/V2) - Added web agents and template separation
271
+ - [Version 1](https://github.com/bmadcode/BMAD-METHOD/tree/V1) - Original 7-file proof of concept
272
+
273
+ See [versions.md](docs/versions.md) for detailed version history and migration guides.
274
+
275
+ ## Author
276
+
277
+ Created by Brian (BMad) Madison
278
+
279
+ ---
280
+
281
+ [![Contributors](https://contrib.rocks/image?repo=bmadcode/bmad-method)](https://github.com/bmadcode/bmad-method/graphs/contributors)
282
+
283
+ <sub>Built with ❤️ for the AI-assisted development community</sub>