Compare commits

..

40 Commits

Author SHA1 Message Date
Brian Madison
3b6a507ab8 require issue tempalte 2025-10-09 18:51:59 -05:00
Brian Madison
415026b0eb v4 readme updated with v6 info 2025-10-04 08:36:13 -05:00
Yoav Gal
91c8e12777 qwen cli - custom commands (#551)
* qwen cli - custom commands

* moved prompt to the inside of the command

---------

Co-authored-by: Davor Racic <davor.racic@gmail.com>
Co-authored-by: Brian <bmadcode@gmail.com>
2025-10-01 16:33:17 -05:00
Brian Madison
458704f82b workflow manual release update 2025-09-29 17:24:46 -05:00
Brian Madison
37e5fd50dd version up 2025-09-29 17:09:18 -05:00
lihangmissu
52f6889089 fix: BMAD Brownfield Document Naming Inconsistency Bug (#627) 2025-09-19 18:08:31 -05:00
Javier Gomez
f09e282d72 feat(opencode): add JSON-only integration and compact AGENTS.md generator (#570)
* feat: add OpenCode integration implementation plan for BMAD-METHOD

* installer(opencode): add OpenCode target metadata in install.config.yaml

* chore(deps): add comment-json for JSONC parsing in OpenCode integration

* feat(installer/opencode): implement setupOpenCode with minimal instructions merge and BMAD-managed agents/commands

* feat(installer): add OpenCode (SST) to IDE selector and CLI --ide help

* fix(opencode): align generated opencode.json(c) with schema (instructions as strings; agent.prompt; command.template; remove unsupported fields)

* feat(installer): enhance OpenCode setup with agent selection and prefix options

* fix: update configuration file references from `bmad-core/core-config.yaml` to `.bmad-core/core-config.yaml` across multiple agent and task files for consistency and clarity.

* refactor: streamline OpenCode configuration prompts and normalize instruction paths for agents and tasks

* feat: add tools property to agent definitions for enhanced functionality. Otherwise opencode consders the subagents as readonly

* feat: add extraction of 'whenToUse'  from agents markdown files for improved agent configuration in opencode

* feat: enhance task purpose extraction from markdown files with improved parsing and cleanup logic

* feat: add collision warnings for non-BMAD-managed agent and command keys during setup

* feat: generate and update AGENTS.md for OpenCode integration with agent and task details

* feat: add compact AGENTS.md generator and JSON-only integration for OpenCode

* chore(docs): remove completed OpenCode integration implementation plans

* feat: enable default prefixes for agent and command keys to avoid collisions

* fix: remove unnecessary line breaks in 'whenToUse' descriptions for QA agents to mathc the rest of the agents definitions and improve programatic parsing of whenToUse prop

* fix: update OpenCode references to remove 'SST' for consistency across documentation and configuration

* fix: update agent mode from 'subagent' to 'all' for consistency in agent definitions

* fix: consolidate 'whenToUse' description format for clarity and consistent parsing
2025-09-11 17:44:41 -05:00
Daniel Dabrowski
2b247ea385 fix: Changed title to coding standards section of brownfield architecture template (#564)
* fix: simplify title in coding standards section of brownfield architecture template

* fix: update section titles in brownfield architecture template for clarity
2025-09-09 18:52:03 -05:00
Brian Madison
925099dd8c remove errant command from readme 2025-09-08 19:36:08 -05:00
Daniel Dabrowski
a19561a16c fix: update workflow file extensions from .md to .yaml in bmad-master.md (#562) 2025-09-08 19:34:23 -05:00
Brian Madison
de6c14df07 documentation updates 2025-09-06 18:30:37 -05:00
sjennings
f20d572216 Godot Game Dev expansion pack for BMAD (#532)
* Godot Game Dev expansion pack for BMAD

* Workflow changes

* Workflow changes

* Fixing config.yaml, editing README.md to indicate correct workflow

* Fixing references to config.yaml, adding missing QA review to game-dev agent

* More game story creation fixes

* More game story creation fixes

* Adding built web agent file

* - Adding ability for QA agent to have preloaded context files similar to Dev agent.
- Fixing stray Unity references in game-architecture-tmpl.yaml

---------

Co-authored-by: Brian <bmadcode@gmail.com>
2025-09-06 13:49:21 -05:00
liyuyun-lyy
076c104b2c feat: add iflow cli support to bmad installer. (#510)
* feat: add iflow cli support

* chore: update project dependencies and development tooling (#508)

- Update various direct and transitive project dependencies.
- Remove the circular `bmad-method` self-dependency.
- Upgrade ESLint, Prettier, Jest, and other dev tools.
- Update semantic-release and related GitHub packages.

Co-authored-by: Kayvan Sylvan <kayvan@meanwhile.bm>

* refactor: refactor by format

---------

Co-authored-by: Kayvan Sylvan <kayvan@sylvan.com>
Co-authored-by: Kayvan Sylvan <kayvan@meanwhile.bm>
Co-authored-by: PinkyD <paulbeanjr@gmail.com>
Co-authored-by: Brian <bmadcode@gmail.com>
2025-09-06 13:44:48 -05:00
Armel BOBDA
87d68d31fd fix: update .gitignore to correct cursor file entry (#485)
This change modifies the .gitignore file to ensure the cursor file is properly ignored by removing the incorrect entry and adding the correct one. This helps maintain a cleaner repository by preventing unnecessary files from being tracked.

Co-authored-by: Brian <bmadcode@gmail.com>
2025-09-06 13:43:05 -05:00
Drilmo
a05b05cec0 fix: Template file extension in validation next story steps (#523)
Co-authored-by: Brian <bmadcode@gmail.com>
2025-09-06 13:40:30 -05:00
VansonLeung
af36864625 Update ide-setup.js - add missing glob require (#514)
Co-authored-by: Brian <bmadcode@gmail.com>
2025-09-06 13:38:29 -05:00
Yoav Gal
5ae4c51883 added gemini cli custom commands! (#549)
* added gemini cli custom commands!

* improvements and changes post review

* updated bmad to BMad

* removed gemini-extension.json

---------

Co-authored-by: Brian <bmadcode@gmail.com>
2025-09-06 13:19:47 -05:00
Yuewen Ma
ac7f2437f8 Fixed: "glob" is not defined (#504)
Co-authored-by: Brian <bmadcode@gmail.com>
2025-09-06 13:16:10 -05:00
Daniel Dabrowski
94f67000b2 feat: enhance file exclusion capabilities with .bmad-flattenignore support (#531)
- Added support for a new optional `.bmad-flattenignore` file to allow users to specify additional files to exclude from the flattened XML output.
- Updated README and documentation to reflect the new feature and provide examples for usage.
- Modified ignore rules to incorporate patterns from the `.bmad-flattenignore` file after applying `.gitignore` rules.

Benefits:
- Greater flexibility in managing file exclusions for AI model consumption.
2025-09-06 13:14:24 -05:00
Hau Vo
155f9591ea feat: Add Auggie CLI (Augment Code) Integration (#520)
* feat: add Augment Code IDE support with multi-location installation options

- Add Augment Code to supported IDE list in installer CLI and interactive prompts
- Configure multi-location setup for Augment Code commands:
  - User Commands: ~/.augment/commands/bmad/ (global, user-wide)
  - Workspace Commands: ./.augment/commands/bmad/ (project-specific, team-shared)
- Update IDE configuration with proper location handling and tilde expansion
- Add interactive prompt for users to select installation locations
- Update documentation in bmad-kb.md to include Augment Code in supported IDEs
- Implement setupAugmentCode method with location selection and file installation

This enables BMAD Method integration with Augment Code's custom command system,
allowing users to access BMad agents via /agent-name slash commands in both
global and project-specific contexts.

* Added options to choose the rule locations

* Update instruction to match with namespace for commands

* Update instruction to match with namespace for commands

* Renamed Augment Code to Auggie CLI (Augment Code)

---------

Co-authored-by: Hau Vo <hauvo@Haus-Mac-mini.local>
Co-authored-by: Brian <bmadcode@gmail.com>
2025-09-02 12:16:26 -05:00
Mikhail Romanov
6919049eae fix: Codex options missing from the IDE selection menu (#535) 2025-09-02 12:13:00 -05:00
Brian Madison
fbd8f1fd73 Expansion pack doc correction 2025-08-31 22:15:40 -05:00
Brian Madison
384e17ff2b docs: remove misplaced Codex section from README
- Remove IDE-specific Codex documentation from end of README
- This content was oddly placed after the footer
- IDE-specific docs should be in separate documentation
2025-08-31 22:05:29 -05:00
Brian Madison
b9bc196e7f chore: sync version to 4.42.1 after release
- Update package.json to match published npm version
- Update installer package.json to match
2025-08-31 21:57:39 -05:00
Brian Madison
0a6cbd72cc chore: bump version to 4.42.0 for release
- Update main package.json to 4.42.0
- Update installer package.json to 4.42.0
- Add PR validation workflow and contribution checks
- Add pre-release and fix scripts
- Update CONTRIBUTING.md with validation requirements
2025-08-31 21:45:21 -05:00
Brian
e2e8d44e5d test: trigger PR validation (#533)
Co-authored-by: Brian Madison <brianmadison@Brians-MacBook-Pro.local>
2025-08-31 20:34:39 -05:00
Brian Madison
fb70c20067 feat: add PR validation workflow and contribution checks 2025-08-31 20:30:52 -05:00
Jonathan Borgwing
05736fa069 feat(installer): add Codex CLI + Codex Web modes, generate AGENTS.md, inject npm scripts, and docs (#529) 2025-08-31 17:48:03 -05:00
Bragatte
052e84dd4a feat: implement fork-friendly CI/CD with opt-in mechanism (#476)
- CI/CD disabled by default in forks to conserve resources
- Users can enable via ENABLE_CI_IN_FORK repository variable
- Added comprehensive Fork Guide documentation
- Updated README with Contributing section
- Created automation script for future implementations

Benefits:
- Saves GitHub Actions minutes across 1,600+ forks
- Cleaner fork experience for contributors
- Full control for fork owners
- PR validation still runs automatically

BREAKING CHANGE: CI/CD no longer runs automatically in forks.
Fork owners must set ENABLE_CI_IN_FORK=true to enable workflows.

Co-authored-by: Brian <bmadcode@gmail.com>
Co-authored-by: PinkyD <paulbeanjr@gmail.com>
2025-08-30 22:15:31 -05:00
Piatra Automation
f054d68c29 fix: correct dependency path format in bmad-master agent (#495)
- Change 'Dependencies map to root/type/name' to 'Dependencies map to {root}/{type}/{name}'
- Fixes path resolution issue where 'root' was treated as literal directory name
- Ensures proper variable interpolation for dependency file loading
- Resolves agent inability to find core-config.yaml and other project files
2025-08-30 22:14:52 -05:00
Wang-tianhao
44836512e7 Update dev.md (#491)
To avoid AI creating new folder for a new story tasks
2025-08-30 22:10:02 -05:00
Chris Calo
bf97f05190 typo in README.md (#515) 2025-08-26 23:57:41 -05:00
Kayvan Sylvan
a900d28080 chore: update project dependencies and development tooling (#508)
- Update various direct and transitive project dependencies.
- Remove the circular `bmad-method` self-dependency.
- Upgrade ESLint, Prettier, Jest, and other dev tools.
- Update semantic-release and related GitHub packages.

Co-authored-by: Kayvan Sylvan <kayvan@meanwhile.bm>
2025-08-24 21:45:18 -05:00
circus
ab70baca59 fix: remove incorrect else branch causing flatten command regression (#452)
This fixes a regression bug where the flatten command would fail with an
error message even when valid arguments were provided.

The bug was:
- First introduced in commit 0fdbca7
- Fixed in commit fab9d5e (v5.0.0-beta.2)
- Accidentally reintroduced in commit ed53943

The else branch at lines 130-134 was incorrectly handling the case when
users provided arguments, showing a misleading error about
'no arguments provided' when arguments were actually present.

Fixes all flatten command variations:
- npx bmad-method flatten
- npx bmad-method flatten --input /path
- npx bmad-method flatten --output file.xml
- npx bmad-method flatten --input /path --output file.xml

Co-authored-by: Brian <bmadcode@gmail.com>
2025-08-17 22:09:56 -05:00
Brian Madison
80d73d9093 fix: documentation and trademark updates 2025-08-17 19:23:50 -05:00
Brian Madison
f3cc410fb0 patch: move script to tools folder 2025-08-17 11:04:27 -05:00
Brian Madison
868ae23455 fix: previous merge set wrong default install location 2025-08-17 11:01:20 -05:00
Brian Madison
9de873777a fix: prettier fixes 2025-08-17 07:51:46 -05:00
Brian Madison
04c485b72e chore: bump to 4.39.1 to fix installer version display 2025-08-17 07:13:09 -05:00
Brian Madison
68eb31da77 fix: update installer version display to show 4.39.0 2025-08-17 07:12:53 -05:00
345 changed files with 71285 additions and 2997 deletions

106
.github/FORK_GUIDE.md vendored Normal file
View File

@@ -0,0 +1,106 @@
# Fork Guide - CI/CD Configuration
## CI/CD in Forks
By default, CI/CD workflows are **disabled in forks** to conserve GitHub Actions resources and provide a cleaner fork experience.
### Why This Approach?
- **Resource efficiency**: Prevents unnecessary GitHub Actions usage across 1,600+ forks
- **Clean fork experience**: No failed workflow notifications in your fork
- **Full control**: Enable CI/CD only when you actually need it
- **PR validation**: Your changes are still fully tested when submitting PRs to the main repository
## Enabling CI/CD in Your Fork
If you need to run CI/CD workflows in your fork, follow these steps:
1. Navigate to your fork's **Settings** tab
2. Go to **Secrets and variables****Actions****Variables**
3. Click **New repository variable**
4. Create a new variable:
- **Name**: `ENABLE_CI_IN_FORK`
- **Value**: `true`
5. Click **Add variable**
That's it! CI/CD workflows will now run in your fork.
## Disabling CI/CD Again
To disable CI/CD workflows in your fork, you can either:
- **Delete the variable**: Remove the `ENABLE_CI_IN_FORK` variable entirely, or
- **Set to false**: Change the `ENABLE_CI_IN_FORK` value to `false`
## Alternative Testing Options
You don't always need to enable CI/CD in your fork. Here are alternatives:
### Local Testing
Run tests locally before pushing:
```bash
# Install dependencies
npm ci
# Run linting
npm run lint
# Run format check
npm run format:check
# Run validation
npm run validate
# Build the project
npm run build
```
### Pull Request CI
When you open a Pull Request to the main repository:
- All CI/CD workflows automatically run
- You get full validation of your changes
- No configuration needed
### GitHub Codespaces
Use GitHub Codespaces for a full development environment:
- All tools pre-configured
- Same environment as CI/CD
- No local setup required
## Frequently Asked Questions
### Q: Will my PR be tested even if CI is disabled in my fork?
**A:** Yes! When you open a PR to the main repository, all CI/CD workflows run automatically, regardless of your fork's settings.
### Q: Can I selectively enable specific workflows?
**A:** The `ENABLE_CI_IN_FORK` variable enables all workflows. For selective control, you'd need to modify individual workflow files.
### Q: Do I need to enable CI in my fork to contribute?
**A:** No! Most contributors never need to enable CI in their forks. Local testing and PR validation are sufficient for most contributions.
### Q: Will disabling CI affect my ability to merge PRs?
**A:** No! PR merge requirements are based on CI runs in the main repository, not your fork.
### Q: Why was this implemented?
**A:** With over 1,600 forks of BMAD-METHOD, this saves thousands of GitHub Actions minutes monthly while maintaining code quality standards.
## Need Help?
- Join our [Discord Community](https://discord.gg/gk8jAdXWmj) for support
- Check the [Contributing Guide](../README.md#contributing) for more information
- Open an issue if you encounter any problems
---
> 💡 **Pro Tip**: This fork-friendly approach is particularly valuable for projects using AI/LLM tools that create many experimental commits, as it prevents unnecessary CI runs while maintaining code quality standards.

5
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Discord Community Support
url: https://discord.gg/gk8jAdXWmj
about: Please join our Discord server for general questions and community discussion before opening an issue.

View File

@@ -14,6 +14,7 @@ name: Discord Notification
jobs:
notify:
runs-on: ubuntu-latest
if: github.event.repository.fork != true || vars.ENABLE_CI_IN_FORK == 'true'
steps:
- name: Notify Discord
uses: sarisia/actions-status-discord@v1

View File

@@ -7,6 +7,7 @@ name: format-check
jobs:
prettier:
runs-on: ubuntu-latest
if: github.event.repository.fork != true || vars.ENABLE_CI_IN_FORK == 'true'
steps:
- name: Checkout
uses: actions/checkout@v4
@@ -25,6 +26,7 @@ jobs:
eslint:
runs-on: ubuntu-latest
if: github.event.repository.fork != true || vars.ENABLE_CI_IN_FORK == 'true'
steps:
- name: Checkout
uses: actions/checkout@v4

View File

@@ -20,12 +20,13 @@ permissions:
jobs:
release:
runs-on: ubuntu-latest
if: github.event.repository.fork != true || vars.ENABLE_CI_IN_FORK == 'true'
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
token: ${{ secrets.GITHUB_TOKEN }}
token: ${{ secrets.GH_PAT }}
- name: Setup Node.js
uses: actions/setup-node@v4

55
.github/workflows/pr-validation.yaml vendored Normal file
View File

@@ -0,0 +1,55 @@
name: PR Validation
on:
pull_request:
branches: [main]
types: [opened, synchronize, reopened]
jobs:
validate:
runs-on: ubuntu-latest
if: github.event.repository.fork != true || vars.ENABLE_CI_IN_FORK == 'true'
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: "20"
cache: npm
- name: Install dependencies
run: npm ci
- name: Run validation
run: npm run validate
- name: Check formatting
run: npm run format:check
- name: Run linter
run: npm run lint
- name: Run tests (if available)
run: npm test --if-present
- name: Comment on PR if checks fail
if: failure()
uses: actions/github-script@v7
with:
script: |
github.rest.issues.createComment({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
body: `❌ **PR Validation Failed**
This PR has validation errors that must be fixed before merging:
- Run \`npm run validate\` to check agent/team configs
- Run \`npm run format:check\` to check formatting (fix with \`npm run format\`)
- Run \`npm run lint\` to check linting issues (fix with \`npm run lint:fix\`)
Please fix these issues and push the changes.`
})

4
.gitignore vendored
View File

@@ -29,13 +29,15 @@ Thumbs.db
# IDE and editor configs
.windsurf/
.trae/
.bmad*/.cursor/
.bmad*/
.cursor/
# AI assistant files
CLAUDE.md
.ai/*
.claude
.gemini
.iflow
# Project-specific
.bmad-core

View File

@@ -1,6 +1,6 @@
# Contributing to this project
Thank you for considering contributing to this project! This document outlines the process for contributing and some guidelines to follow.
Thank you for contributing to this project! This document outlines the process for contributing and some guidelines to follow.
🆕 **New to GitHub or pull requests?** Check out our [beginner-friendly Pull Request Guide](docs/how-to-contribute-with-pull-requests.md) first!
@@ -8,15 +8,53 @@ Thank you for considering contributing to this project! This document outlines t
Also note, we use the discussions feature in GitHub to have a community to discuss potential ideas, uses, additions and enhancements.
💬 **Discord Community**: Join our [Discord server](https://discord.gg/gk8jAdXWmj) for real-time discussions:
- **#general-dev** - Technical discussions, feature ideas, and development questions
- **#bugs-issues** - Bug reports and issue discussions
💬 **Discord Community**: Join our [Discord server](https://discord.gg/gk8jAdXWmj) for real-time discussions or search past discussions or ideas.
## Code of Conduct
By participating in this project, you agree to abide by our Code of Conduct. Please read it before participating.
## Before Submitting a PR
**IMPORTANT**: All PRs must pass validation checks before they can be merged.
### Required Checks
Before submitting your PR, run these commands locally:
```bash
# Run all validation checks
npm run pre-release
# Or run them individually:
npm run validate # Validate agent/team configs
npm run format:check # Check code formatting
npm run lint # Check for linting issues
```
### Fixing Issues
If any checks fail, use these commands to fix them:
```bash
# Fix all issues automatically
npm run fix
# Or fix individually:
npm run format # Fix formatting issues
npm run lint:fix # Fix linting issues
```
### Setup Git Hooks (Optional but Recommended)
To catch issues before committing:
```bash
# Run this once after cloning
chmod +x tools/setup-hooks.sh
./tools/setup-hooks.sh
```
## How to Contribute
### Reporting Bugs
@@ -150,10 +188,6 @@ Fixes #[issue number] (if applicable)
[2-3 bullets listing HOW you implemented it]
-
-
-
## Testing
[1-2 sentences on how you tested this]
@@ -206,4 +240,4 @@ Each commit should represent one logical change:
## License
By contributing to this project, you agree that your contributions will be licensed under the same license as the project.
By contributing to this project, you agree that your contributions will be licensed under the MIT License.

View File

@@ -1,6 +1,6 @@
MIT License
Copyright (c) 2025 Brian AKA BMad AKA BMad Code
Copyright (c) 2025 BMad Code, LLC
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
@@ -19,3 +19,8 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
TRADEMARK NOTICE:
BMAD™ and BMAD-METHOD™ are trademarks of BMad Code, LLC. The use of these
trademarks in this software does not grant any rights to use the trademarks
for any other purpose.

View File

@@ -0,0 +1,40 @@
# feat(opencode): compact AGENTS.md generator and JSON-only integration
## What
Add JSON-only OpenCode integration and a compact AGENTS.md generator (no large embeds; clickable file links) with idempotent merges for BMAD instructions, agents, and commands.
## Why
Keep OpenCode config schemacompliant and small, avoid key collisions, and provide a readable agents/tasks index without inflating AGENTS.md.
## How
- Ensure `.bmad-core/core-config.yaml` in `instructions`
- Merge only selected packages agents/commands into opencode.json file
- Orchestrators `mode: primary`; all agents enable `write`, `edit`, `bash`
- Descriptions from `whenToUse`/task `Purpose` with sanitization + fallbacks
- Explicit warnings for nonBMAD collisions; AGENTS.md uses a strict 3column table with links
## Testing
- Run: `npx bmad-method install -f -i opencode`
- Verify: `opencode.json[c]` updated/created as expected, `AGENTS.md` OpenCode section is compact with links
- Prepush checks:
```bash
npm run pre-release
# or individually
npm run validate
npm run format:check
npm run lint
# if anything fails
npm run fix
# or
npm run format
npm run lint:fix
```
Fixes #<issue-number>
Targets: `next` branch

149
README.md
View File

@@ -1,4 +1,35 @@
# BMad-Method: Universal AI Agent Framework
# BMAD-METHOD™: Universal AI Agent Framework
> ## 🚨 **IMPORTANT VERSION ANNOUNCEMENT** 🚨
>
> ### Current Stable: v4.x | Next Major: v6 Alpha
>
> - **v4.x** - The current stable release version available via npm
> - **v5** - Skipped (replaced by v6)
> - **[v6-alpha](https://github.com/bmad-code-org/BMAD-METHOD/tree/v6-alpha)** - **NOW AVAILABLE FOR EARLY TESTING!**
>
> ### 🧪 Try v6 Alpha (Early Adopters Only)
>
> The next major version of BMAD-METHOD is now available for early experimentation and testing. This is a complete rewrite with significant architectural changes.
>
> **⚠️ WARNING: v6-alpha is for early adopters who are comfortable with:**
>
> - Potential breaking changes
> - Daily updates and instability
> - Incomplete features
> - Experimental functionality
>
> **📅 Timeline:** Official beta version will be merged mid-October 2025
>
> **To try v6-alpha:**
>
> ```bash
> git clone https://github.com/bmad-code-org/BMAD-METHOD.git
> cd BMAD-METHOD
> git checkout v6-alpha
> ```
>
> ---
[![Version](https://img.shields.io/npm/v/bmad-method?color=blue&label=version)](https://www.npmjs.com/package/bmad-method)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
@@ -11,11 +42,11 @@ Foundations in Agentic Agile Driven Development, known as the Breakthrough Metho
**[Join our Discord Community](https://discord.gg/gk8jAdXWmj)** - A growing community for AI enthusiasts! Get help, share ideas, explore AI agents & frameworks, collaborate on tech projects, enjoy hobbies, and help each other succeed. Whether you're stuck on BMad, building your own agents, or just want to chat about the latest in AI - we're here for you! **Some mobile and VPN may have issue joining the discord, this is a discord issue - if the invite does not work, try from your own internet or another network, or non-VPN.**
**If you find this project helpful or useful, please give it a star in the upper right hand corner!** It helps others discover BMad-Method and you will be notified of updates!
**If you find this project helpful or useful, please give it a star in the upper right hand corner!** It helps others discover BMAD-METHOD™ and you will be notified of updates!
## Overview
**BMad Method's Two Key Innovations:**
**BMAD-METHOD™'s Two Key Innovations:**
**1. Agentic Planning:** Dedicated agents (Analyst, PM, Architect) collaborate with you to create detailed, consistent PRDs and Architecture documents. Through advanced prompt engineering and human-in-the-loop refinement, these planning agents produce comprehensive specifications that go far beyond generic AI task generation.
@@ -40,7 +71,7 @@ This two-phase approach eliminates both **planning inconsistency** and **context
- **[Install and Build software with Full Stack Agile AI Team](#quick-start)** → Quick Start Instruction
- **[Learn how to use BMad](docs/user-guide.md)** → Complete user guide and walkthrough
- **[See available AI agents](/bmad-core/agents))** → Specialized roles for your team
- **[See available AI agents](/bmad-core/agents)** → Specialized roles for your team
- **[Explore non-technical uses](#-beyond-software-development---expansion-packs)** → Creative writing, business, wellness, education
- **[Create my own AI agents](docs/expansion-packs.md)** → Build agents for your domain
- **[Browse ready-made expansion packs](expansion-packs/)** → Game dev, DevOps, infrastructure and get inspired with ideas and examples
@@ -49,7 +80,7 @@ This two-phase approach eliminates both **planning inconsistency** and **context
## Important: Keep Your BMad Installation Updated
**Stay up-to-date effortlessly!** If you already have BMad-Method installed in your project, simply run:
**Stay up-to-date effortlessly!** If you already have BMAD-METHOD™ installed in your project, simply run:
```bash
npx bmad-method install
@@ -75,8 +106,6 @@ This makes it easy to benefit from the latest improvements, bug fixes, and new a
```bash
npx bmad-method install
# OR explicitly use stable tag:
npx bmad-method@stable install
# OR if you already have BMad installed:
git pull
npm run install:bmad
@@ -110,87 +139,7 @@ npm run install:bmad # build and install all to a destination folder
## 🌟 Beyond Software Development - Expansion Packs
BMad's natural language framework works in ANY domain. Expansion packs provide specialized AI agents for creative writing, business strategy, health & wellness, education, and more. Also expansion packs can expand the core BMad-Method with specific functionality that is not generic for all cases. [See the Expansion Packs Guide](docs/expansion-packs.md) and learn to create your own!
## Codebase Flattener Tool
The BMad-Method includes a powerful codebase flattener tool designed to prepare your project files for AI model consumption. This tool aggregates your entire codebase into a single XML file, making it easy to share your project context with AI assistants for analysis, debugging, or development assistance.
### Features
- **AI-Optimized Output**: Generates clean XML format specifically designed for AI model consumption
- **Smart Filtering**: Automatically respects `.gitignore` patterns to exclude unnecessary files
- **Binary File Detection**: Intelligently identifies and excludes binary files, focusing on source code
- **Progress Tracking**: Real-time progress indicators and comprehensive completion statistics
- **Flexible Output**: Customizable output file location and naming
### Usage
```bash
# Basic usage - creates flattened-codebase.xml in current directory
npx bmad-method flatten
# Specify custom input directory
npx bmad-method flatten --input /path/to/source/directory
npx bmad-method flatten -i /path/to/source/directory
# Specify custom output file
npx bmad-method flatten --output my-project.xml
npx bmad-method flatten -o /path/to/output/codebase.xml
# Combine input and output options
npx bmad-method flatten --input /path/to/source --output /path/to/output/codebase.xml
```
### Example Output
The tool will display progress and provide a comprehensive summary:
```text
📊 Completion Summary:
✅ Successfully processed 156 files into flattened-codebase.xml
📁 Output file: /path/to/your/project/flattened-codebase.xml
📏 Total source size: 2.3 MB
📄 Generated XML size: 2.1 MB
📝 Total lines of code: 15,847
🔢 Estimated tokens: 542,891
📊 File breakdown: 142 text, 14 binary, 0 errors
```
The generated XML file contains your project's text-based source files in a structured format that AI models can easily parse and understand, making it perfect for code reviews, architecture discussions, or getting AI assistance with your BMad-Method projects.
#### Advanced Usage & Options
- CLI options
- `-i, --input <path>`: Directory to flatten. Default: current working directory or auto-detected project root when run interactively.
- `-o, --output <path>`: Output file path. Default: `flattened-codebase.xml` in the chosen directory.
- Interactive mode
- If you do not pass `--input` and `--output` and the terminal is interactive (TTY), the tool will attempt to detect your project root (by looking for markers like `.git`, `package.json`, etc.) and prompt you to confirm or override the paths.
- In non-interactive contexts (e.g., CI), it will prefer the detected root silently; otherwise it falls back to the current directory and default filename.
- File discovery and ignoring
- Uses `git ls-files` when inside a git repository for speed and correctness; otherwise falls back to a glob-based scan.
- Applies your `.gitignore` plus a curated set of default ignore patterns (e.g., `node_modules`, build outputs, caches, logs, IDE folders, lockfiles, large media/binaries, `.env*`, and previously generated XML outputs).
- Binary handling
- Binary files are detected and excluded from the XML content. They are counted in the final summary but not embedded in the output.
- XML format and safety
- UTF-8 encoded file with root element `<files>`.
- Each text file is emitted as a `<file path="relative/path">` element whose content is wrapped in `<![CDATA[ ... ]]>`.
- The tool safely handles occurrences of `]]>` inside content by splitting the CDATA to preserve correctness.
- File contents are preserved as-is and indented for readability inside the XML.
- Performance
- Concurrency is selected automatically based on your CPU and workload size. No configuration required.
- Running inside a git repo improves discovery performance.
#### Minimal XML example
```xml
<?xml version="1.0" encoding="UTF-8"?>
<files>
<file path="src/index.js"><![CDATA[
// your source content
]]></file>
</files>
```
BMAD™'s natural language framework works in ANY domain. Expansion packs provide specialized AI agents for creative writing, business strategy, health & wellness, education, and more. Also expansion packs can expand the core BMAD-METHOD™ with specific functionality that is not generic for all cases. [See the Expansion Packs Guide](docs/expansion-packs.md) and learn to create your own!
## Documentation & Resources
@@ -212,10 +161,34 @@ The generated XML file contains your project's text-based source files in a stru
📋 **[Read CONTRIBUTING.md](CONTRIBUTING.md)** - Complete guide to contributing, including guidelines, process, and requirements
### Working with Forks
When you fork this repository, CI/CD workflows are **disabled by default** to save resources. This is intentional and helps keep your fork clean.
#### Need CI/CD in Your Fork?
See our [Fork CI/CD Guide](.github/FORK_GUIDE.md) for instructions on enabling workflows in your fork.
#### Contributing Workflow
1. **Fork the repository** - Click the Fork button on GitHub
2. **Clone your fork** - `git clone https://github.com/YOUR-USERNAME/BMAD-METHOD.git`
3. **Create a feature branch** - `git checkout -b feature/amazing-feature`
4. **Make your changes** - Test locally with `npm test`
5. **Commit your changes** - `git commit -m 'feat: add amazing feature'`
6. **Push to your fork** - `git push origin feature/amazing-feature`
7. **Open a Pull Request** - CI/CD will run automatically on the PR
Your contributions are tested when you submit a PR - no need to enable CI in your fork!
## License
MIT License - see [LICENSE](LICENSE) for details.
## Trademark Notice
BMAD™ and BMAD-METHOD™ are trademarks of BMad Code, LLC. All rights reserved.
[![Contributors](https://contrib.rocks/image?repo=bmadcode/bmad-method)](https://github.com/bmadcode/bmad-method/graphs/contributors)
<sub>Built with ❤️ for the AI-assisted development community</sub>

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
bundle:
name: Team All
icon: 👥

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
bundle:
name: Team Fullstack
icon: 🚀

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
bundle:
name: Team IDE Minimal
icon:

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
bundle:
name: Team No UI
icon: 🔧

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# analyst
ACTIVATION-NOTICE: This file contains your full agent operating guidelines. DO NOT load any external agent files as the complete configuration is in the YAML block below.
@@ -17,7 +19,7 @@ REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (
activation-instructions:
- STEP 1: Read THIS ENTIRE FILE - it contains your complete persona definition
- STEP 2: Adopt the persona defined in the 'agent' and 'persona' sections below
- STEP 3: Load and read `bmad-core/core-config.yaml` (project configuration) before any greeting
- STEP 3: Load and read `.bmad-core/core-config.yaml` (project configuration) before any greeting
- STEP 4: Greet user with your name/role and immediately run `*help` to display available commands
- DO NOT: Load any other agent files during activation
- ONLY load dependency files when user selects them for execution via command or request of a task

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# architect
ACTIVATION-NOTICE: This file contains your full agent operating guidelines. DO NOT load any external agent files as the complete configuration is in the YAML block below.
@@ -17,7 +19,7 @@ REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (
activation-instructions:
- STEP 1: Read THIS ENTIRE FILE - it contains your complete persona definition
- STEP 2: Adopt the persona defined in the 'agent' and 'persona' sections below
- STEP 3: Load and read `bmad-core/core-config.yaml` (project configuration) before any greeting
- STEP 3: Load and read `.bmad-core/core-config.yaml` (project configuration) before any greeting
- STEP 4: Greet user with your name/role and immediately run `*help` to display available commands
- DO NOT: Load any other agent files during activation
- ONLY load dependency files when user selects them for execution via command or request of a task

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# BMad Master
ACTIVATION-NOTICE: This file contains your full agent operating guidelines. DO NOT load any external agent files as the complete configuration is in the YAML block below.
@@ -9,16 +11,16 @@ CRITICAL: Read the full YAML BLOCK that FOLLOWS IN THIS FILE to understand your
```yaml
IDE-FILE-RESOLUTION:
- FOR LATER USE ONLY - NOT FOR ACTIVATION, when executing commands that reference dependencies
- Dependencies map to root/type/name
- Dependencies map to {root}/{type}/{name}
- type=folder (tasks|templates|checklists|data|utils|etc...), name=file-name
- Example: create-doc.md → root/tasks/create-doc.md
- Example: create-doc.md → {root}/tasks/create-doc.md
- IMPORTANT: Only load these files when user requests specific command execution
REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), ALWAYS ask for clarification if no clear match.
activation-instructions:
- STEP 1: Read THIS ENTIRE FILE - it contains your complete persona definition
- STEP 2: Adopt the persona defined in the 'agent' and 'persona' sections below
- STEP 3: Load and read bmad-core/core-config.yaml (project configuration) before any greeting
- STEP 4: Greet user with your name/role and immediately run *help to display available commands
- STEP 3: Load and read `.bmad-core/core-config.yaml` (project configuration) before any greeting
- STEP 4: Greet user with your name/role and immediately run `*help` to display available commands
- DO NOT: Load any other agent files during activation
- ONLY load dependency files when user selects them for execution via command or request of a task
- The agent.customization field ALWAYS takes precedence over any conflicting instructions
@@ -99,10 +101,10 @@ dependencies:
- project-brief-tmpl.yaml
- story-tmpl.yaml
workflows:
- brownfield-fullstack.md
- brownfield-service.md
- brownfield-ui.md
- greenfield-fullstack.md
- greenfield-service.md
- greenfield-ui.md
- brownfield-fullstack.yaml
- brownfield-service.yaml
- brownfield-ui.yaml
- greenfield-fullstack.yaml
- greenfield-service.yaml
- greenfield-ui.yaml
```

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# BMad Web Orchestrator
ACTIVATION-NOTICE: This file contains your full agent operating guidelines. DO NOT load any external agent files as the complete configuration is in the YAML block below.
@@ -17,7 +19,7 @@ REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (
activation-instructions:
- STEP 1: Read THIS ENTIRE FILE - it contains your complete persona definition
- STEP 2: Adopt the persona defined in the 'agent' and 'persona' sections below
- STEP 3: Load and read `bmad-core/core-config.yaml` (project configuration) before any greeting
- STEP 3: Load and read `.bmad-core/core-config.yaml` (project configuration) before any greeting
- STEP 4: Greet user with your name/role and immediately run `*help` to display available commands
- DO NOT: Load any other agent files during activation
- ONLY load dependency files when user selects them for execution via command or request of a task
@@ -29,7 +31,7 @@ activation-instructions:
- Assess user goal against available agents and workflows in this bundle
- If clear match to an agent's expertise, suggest transformation with *agent command
- If project-oriented, suggest *workflow-guidance to explore options
- Load resources only when needed - never pre-load (Exception: Read `bmad-core/core-config.yaml` during activation)
- Load resources only when needed - never pre-load (Exception: Read `.bmad-core/core-config.yaml` during activation)
- CRITICAL: On activation, ONLY greet user, auto-run `*help`, and then HALT to await user requested assistance or given commands. ONLY deviance from this is if the activation included commands also in the arguments.
agent:
name: BMad Orchestrator

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# dev
ACTIVATION-NOTICE: This file contains your full agent operating guidelines. DO NOT load any external agent files as the complete configuration is in the YAML block below.
@@ -17,7 +19,7 @@ REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (
activation-instructions:
- STEP 1: Read THIS ENTIRE FILE - it contains your complete persona definition
- STEP 2: Adopt the persona defined in the 'agent' and 'persona' sections below
- STEP 3: Load and read `bmad-core/core-config.yaml` (project configuration) before any greeting
- STEP 3: Load and read `.bmad-core/core-config.yaml` (project configuration) before any greeting
- STEP 4: Greet user with your name/role and immediately run `*help` to display available commands
- DO NOT: Load any other agent files during activation
- ONLY load dependency files when user selects them for execution via command or request of a task
@@ -47,6 +49,7 @@ persona:
core_principles:
- CRITICAL: Story has ALL info you will need aside from what you loaded during the startup commands. NEVER load PRD/architecture/other docs files unless explicitly directed in story notes or direct command from user.
- CRITICAL: ALWAYS check current folder structure before starting your story tasks, don't create new working directory if it already exists. Create new one when you're sure it's a brand new project.
- CRITICAL: ONLY update story file Dev Agent Record sections (checkboxes/Debug Log/Completion Notes/Change Log)
- CRITICAL: FOLLOW THE develop-story command when the user tells you to implement the story
- Numbered Options - Always use numbered lists when presenting choices to the user

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# pm
ACTIVATION-NOTICE: This file contains your full agent operating guidelines. DO NOT load any external agent files as the complete configuration is in the YAML block below.
@@ -17,7 +19,7 @@ REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (
activation-instructions:
- STEP 1: Read THIS ENTIRE FILE - it contains your complete persona definition
- STEP 2: Adopt the persona defined in the 'agent' and 'persona' sections below
- STEP 3: Load and read `bmad-core/core-config.yaml` (project configuration) before any greeting
- STEP 3: Load and read `.bmad-core/core-config.yaml` (project configuration) before any greeting
- STEP 4: Greet user with your name/role and immediately run `*help` to display available commands
- DO NOT: Load any other agent files during activation
- ONLY load dependency files when user selects them for execution via command or request of a task

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# po
ACTIVATION-NOTICE: This file contains your full agent operating guidelines. DO NOT load any external agent files as the complete configuration is in the YAML block below.
@@ -17,7 +19,7 @@ REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (
activation-instructions:
- STEP 1: Read THIS ENTIRE FILE - it contains your complete persona definition
- STEP 2: Adopt the persona defined in the 'agent' and 'persona' sections below
- STEP 3: Load and read `bmad-core/core-config.yaml` (project configuration) before any greeting
- STEP 3: Load and read `.bmad-core/core-config.yaml` (project configuration) before any greeting
- STEP 4: Greet user with your name/role and immediately run `*help` to display available commands
- DO NOT: Load any other agent files during activation
- ONLY load dependency files when user selects them for execution via command or request of a task

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# qa
ACTIVATION-NOTICE: This file contains your full agent operating guidelines. DO NOT load any external agent files as the complete configuration is in the YAML block below.
@@ -17,7 +19,7 @@ REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (
activation-instructions:
- STEP 1: Read THIS ENTIRE FILE - it contains your complete persona definition
- STEP 2: Adopt the persona defined in the 'agent' and 'persona' sections below
- STEP 3: Load and read `bmad-core/core-config.yaml` (project configuration) before any greeting
- STEP 3: Load and read `.bmad-core/core-config.yaml` (project configuration) before any greeting
- STEP 4: Greet user with your name/role and immediately run `*help` to display available commands
- DO NOT: Load any other agent files during activation
- ONLY load dependency files when user selects them for execution via command or request of a task
@@ -33,11 +35,7 @@ agent:
id: qa
title: Test Architect & Quality Advisor
icon: 🧪
whenToUse: |
Use for comprehensive test architecture review, quality gate decisions,
and code improvement. Provides thorough analysis including requirements
traceability, risk assessment, and test strategy.
Advisory only - teams choose their quality bar.
whenToUse: Use for comprehensive test architecture review, quality gate decisions, and code improvement. Provides thorough analysis including requirements traceability, risk assessment, and test strategy. Advisory only - teams choose their quality bar.
customization: null
persona:
role: Test Architect with Quality Advisory Authority

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# sm
ACTIVATION-NOTICE: This file contains your full agent operating guidelines. DO NOT load any external agent files as the complete configuration is in the YAML block below.
@@ -17,7 +19,7 @@ REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (
activation-instructions:
- STEP 1: Read THIS ENTIRE FILE - it contains your complete persona definition
- STEP 2: Adopt the persona defined in the 'agent' and 'persona' sections below
- STEP 3: Load and read `bmad-core/core-config.yaml` (project configuration) before any greeting
- STEP 3: Load and read `.bmad-core/core-config.yaml` (project configuration) before any greeting
- STEP 4: Greet user with your name/role and immediately run `*help` to display available commands
- DO NOT: Load any other agent files during activation
- ONLY load dependency files when user selects them for execution via command or request of a task

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# ux-expert
ACTIVATION-NOTICE: This file contains your full agent operating guidelines. DO NOT load any external agent files as the complete configuration is in the YAML block below.
@@ -17,7 +19,7 @@ REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (
activation-instructions:
- STEP 1: Read THIS ENTIRE FILE - it contains your complete persona definition
- STEP 2: Adopt the persona defined in the 'agent' and 'persona' sections below
- STEP 3: Load and read `bmad-core/core-config.yaml` (project configuration) before any greeting
- STEP 3: Load and read `.bmad-core/core-config.yaml` (project configuration) before any greeting
- STEP 4: Greet user with your name/role and immediately run `*help` to display available commands
- DO NOT: Load any other agent files during activation
- ONLY load dependency files when user selects them for execution via command or request of a task

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Architect Solution Validation Checklist
This checklist serves as a comprehensive framework for the Architect to validate the technical design and architecture before development execution. The Architect should systematically work through each item, ensuring the architecture is robust, scalable, secure, and aligned with the product requirements.

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Change Navigation Checklist
**Purpose:** To systematically guide the selected Agent and user through the analysis and planning required when a significant change (pivot, tech issue, missing requirement, failed story) is identified during the BMad workflow.

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Product Manager (PM) Requirements Checklist
This checklist serves as a comprehensive framework to ensure the Product Requirements Document (PRD) and Epic definitions are complete, well-structured, and appropriately scoped for MVP development. The PM should systematically work through each item during the product definition process.

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Product Owner (PO) Master Validation Checklist
This checklist serves as a comprehensive framework for the Product Owner to validate project plans before development execution. It adapts intelligently based on project type (greenfield vs brownfield) and includes UI/UX considerations when applicable.
@@ -13,7 +15,7 @@ First, determine the project type by checking:
2. Is this a BROWNFIELD project (enhancing existing system)?
- Look for: References to existing codebase, enhancement/modification language
- Check for: brownfield-prd.md, brownfield-architecture.md, existing system analysis
- Check for: prd.md, architecture.md, existing system analysis
3. Does the project include UI/UX components?
- Check for: frontend-architecture.md, UI/UX specifications, design files
@@ -31,8 +33,8 @@ For GREENFIELD projects:
For BROWNFIELD projects:
- brownfield-prd.md - The brownfield enhancement requirements
- brownfield-architecture.md - The enhancement architecture
- prd.md - The brownfield enhancement requirements
- architecture.md - The enhancement architecture
- Existing project codebase access (CRITICAL - cannot proceed without this)
- Current deployment configuration and infrastructure details
- Database schemas, API documentation, monitoring setup

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Story Definition of Done (DoD) Checklist
## Instructions for Developer Agent

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Story Draft Checklist
The Scrum Master should use this checklist to validate that each story contains sufficient context for a developer agent to implement it successfully, while assuming the dev agent has reasonable capabilities to figure things out.

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
markdownExploder: true
qa:
qaLocation: docs/qa

View File

@@ -1,8 +1,10 @@
# BMad Knowledge Base
<!-- Powered by BMAD™ Core -->
# BMAD™ Knowledge Base
## Overview
BMad-Method (Breakthrough Method of Agile AI-driven Development) is a framework that combines AI agents with Agile development methodologies. The v4 system introduces a modular architecture with improved dependency management, bundle optimization, and support for both web and IDE environments.
BMAD-METHOD™ (Breakthrough Method of Agile AI-driven Development) is a framework that combines AI agents with Agile development methodologies. The v4 system introduces a modular architecture with improved dependency management, bundle optimization, and support for both web and IDE environments.
### Key Features
@@ -100,8 +102,9 @@ npx bmad-method install
- **Cline**: VS Code extension with AI features
- **Roo Code**: Web-based IDE with agent support
- **GitHub Copilot**: VS Code extension with AI peer programming assistant
- **Auggie CLI (Augment Code)**: AI-powered development environment
**Note for VS Code Users**: BMad-Method assumes when you mention "VS Code" that you're using it with an AI-powered extension like GitHub Copilot, Cline, or Roo. Standard VS Code without AI capabilities cannot run BMad agents. The installer includes built-in support for Cline and Roo.
**Note for VS Code Users**: BMAD-METHOD™ assumes when you mention "VS Code" that you're using it with an AI-powered extension like GitHub Copilot, Cline, or Roo. Standard VS Code without AI capabilities cannot run BMad agents. The installer includes built-in support for Cline and Roo.
**Verify Installation**:
@@ -109,7 +112,7 @@ npx bmad-method install
- IDE-specific integration files created
- All agent commands/rules/modes available
**Remember**: At its core, BMad-Method is about mastering and harnessing prompt engineering. Any IDE with AI agent support can use BMad - the framework provides the structured prompts and workflows that make AI development effective
**Remember**: At its core, BMAD-METHOD™ is about mastering and harnessing prompt engineering. Any IDE with AI agent support can use BMad - the framework provides the structured prompts and workflows that make AI development effective
### Environment Selection Guide
@@ -178,7 +181,7 @@ npx bmad-method install
## Core Configuration (core-config.yaml)
**New in V4**: The `bmad-core/core-config.yaml` file is a critical innovation that enables BMad to work seamlessly with any project structure, providing maximum flexibility and backwards compatibility.
**New in V4**: The `.bmad-core/core-config.yaml` file is a critical innovation that enables BMad to work seamlessly with any project structure, providing maximum flexibility and backwards compatibility.
### What is core-config.yaml?
@@ -353,7 +356,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
### System Overview
The BMad-Method is built around a modular architecture centered on the `bmad-core` directory, which serves as the brain of the entire system. This design enables the framework to operate effectively in both IDE environments (like Cursor, VS Code) and web-based AI interfaces (like ChatGPT, Gemini).
The BMAD-METHOD™ is built around a modular architecture centered on the `bmad-core` directory, which serves as the brain of the entire system. This design enables the framework to operate effectively in both IDE environments (like Cursor, VS Code) and web-based AI interfaces (like ChatGPT, Gemini).
### Key Architectural Components
@@ -708,7 +711,7 @@ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sh
- **Keep conversations focused** - One agent, one task per conversation
- **Review everything** - Always review and approve before marking complete
## Contributing to BMad-Method
## Contributing to BMAD-METHOD™
### Quick Contribution Guidelines
@@ -740,7 +743,7 @@ For full details, see `CONTRIBUTING.md`. Key points:
### What Are Expansion Packs?
Expansion packs extend BMad-Method beyond traditional software development into ANY domain. They provide specialized agent teams, templates, and workflows while keeping the core framework lean and focused on development.
Expansion packs extend BMAD-METHOD™ beyond traditional software development into ANY domain. They provide specialized agent teams, templates, and workflows while keeping the core framework lean and focused on development.
### Why Use Expansion Packs?

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Brainstorming Techniques Data
## Creative Expansion

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Elicitation Methods Data
## Core Reflective Methods

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# User-Defined Preferred Patterns and Preferences
None Listed

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Test Levels Framework
Comprehensive guide for determining appropriate test levels (unit, integration, E2E) for different scenarios.

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Test Priorities Matrix
Guide for prioritizing test scenarios based on risk, criticality, and business impact.

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Advanced Elicitation Task
## Purpose

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# apply-qa-fixes
Implement fixes based on QA results (gate and assessments) for a specific story. This task is for the Dev agent to systematically consume QA outputs and apply code/test changes while only updating allowed sections in the story file.
@@ -14,8 +16,8 @@ Implement fixes based on QA results (gate and assessments) for a specific story.
```yaml
required:
- story_id: '{epic}.{story}' # e.g., "2.2"
- qa_root: from `bmad-core/core-config.yaml` key `qa.qaLocation` (e.g., `docs/project/qa`)
- story_root: from `bmad-core/core-config.yaml` key `devStoryLocation` (e.g., `docs/project/stories`)
- qa_root: from `.bmad-core/core-config.yaml` key `qa.qaLocation` (e.g., `docs/project/qa`)
- story_root: from `.bmad-core/core-config.yaml` key `devStoryLocation` (e.g., `docs/project/stories`)
optional:
- story_title: '{title}' # derive from story H1 if missing
@@ -43,7 +45,7 @@ optional:
### 0) Load Core Config & Locate Story
- Read `bmad-core/core-config.yaml` and resolve `qa_root` and `story_root`
- Read `.bmad-core/core-config.yaml` and resolve `qa_root` and `story_root`
- Locate story file in `{story_root}/{epic}.{story}.*.md`
- HALT if missing and ask for correct story id/path
@@ -111,7 +113,7 @@ Status Rule:
## Blocking Conditions
- Missing `bmad-core/core-config.yaml`
- Missing `.bmad-core/core-config.yaml`
- Story file not found for `story_id`
- No QA artifacts found (neither gate nor assessments)
- HALT and request QA to generate at least a gate file (or proceed only with clear developer-provided fix list)

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Create Brownfield Epic Task
## Purpose

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Create Brownfield Story Task
## Purpose

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Correct Course Task
## Purpose

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Create Brownfield Story Task
## Purpose

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Create Deep Research Prompt Task
This task helps create comprehensive research prompts for various types of deep analysis. It can process inputs from brainstorming sessions, project briefs, market research, or specific research questions to generate targeted prompts for deeper investigation.

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Create Next Story Task
## Purpose

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Document an Existing Project
## Purpose

View File

@@ -1,6 +1,8 @@
---
## <!-- Powered by BMAD™ Core -->
docOutputLocation: docs/brainstorming-session-results.md
template: '{root}/templates/brainstorming-output-tmpl.yaml'
---
# Facilitate Brainstorming Session Task

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Create AI Frontend Prompt Task
## Purpose

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Index Documentation Task
## Purpose

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# KB Mode Interaction Task
## Purpose

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# nfr-assess
Quick NFR validation focused on the core four: security, performance, reliability, maintainability.
@@ -7,11 +9,11 @@ Quick NFR validation focused on the core four: security, performance, reliabilit
```yaml
required:
- story_id: '{epic}.{story}' # e.g., "1.3"
- story_path: `bmad-core/core-config.yaml` for the `devStoryLocation`
- story_path: `.bmad-core/core-config.yaml` for the `devStoryLocation`
optional:
- architecture_refs: `bmad-core/core-config.yaml` for the `architecture.architectureFile`
- technical_preferences: `bmad-core/core-config.yaml` for the `technicalPreferences`
- architecture_refs: `.bmad-core/core-config.yaml` for the `architecture.architectureFile`
- technical_preferences: `.bmad-core/core-config.yaml` for the `technicalPreferences`
- acceptance_criteria: From story file
```

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# qa-gate
Create or update a quality gate decision file for a story based on review findings.
@@ -14,7 +16,7 @@ Generate a standalone quality gate file that provides a clear pass/fail decision
## Gate File Location
**ALWAYS** check the `bmad-core/core-config.yaml` for the `qa.qaLocation/gates`
**ALWAYS** check the `.bmad-core/core-config.yaml` for the `qa.qaLocation/gates`
Slug rules:
@@ -124,7 +126,7 @@ waiver:
## Output Requirements
1. **ALWAYS** create gate file at: `qa.qaLocation/gates` from `bmad-core/core-config.yaml`
1. **ALWAYS** create gate file at: `qa.qaLocation/gates` from `.bmad-core/core-config.yaml`
2. **ALWAYS** append this exact format to story's QA Results section:
```text

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# review-story
Perform a comprehensive test architecture review with quality gate decision. This adaptive, risk-aware review creates both a story update and a detailed gate file.
@@ -184,7 +186,7 @@ NFR assessment: qa.qaLocation/assessments/{epic}.{story}-nfr-{YYYYMMDD}.md
**Template and Directory:**
- Render from `../templates/qa-gate-tmpl.yaml`
- Create directory defined in `qa.qaLocation/gates` (see `bmad-core/core-config.yaml`) if missing
- Create directory defined in `qa.qaLocation/gates` (see `.bmad-core/core-config.yaml`) if missing
- Save to: `qa.qaLocation/gates/{epic}.{story}-{slug}.yml`
Gate file structure:

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# risk-profile
Generate a comprehensive risk assessment matrix for a story implementation using probability × impact analysis.

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Document Sharding Task
## Purpose

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# test-design
Create comprehensive test scenarios with appropriate test level recommendations for story implementation.

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# trace-requirements
Map story requirements to test cases using Given-When-Then patterns for comprehensive traceability.

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Validate Next Story Task
## Purpose
@@ -19,7 +21,7 @@ To comprehensively validate a story draft before implementation begins, ensuring
### 1. Template Completeness Validation
- Load `bmad-core/templates/story-tmpl.md` and extract all section headings from the template
- Load `.bmad-core/templates/story-tmpl.yaml` and extract all section headings from the template
- **Missing sections check**: Compare story sections against template sections to verify all required sections are present
- **Placeholder validation**: Ensure no template placeholders remain unfilled (e.g., `{{EpicNum}}`, `{{role}}`, `_TBD_`)
- **Agent section verification**: Confirm all sections from template exist for future agent use

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
template:
id: architecture-template-v2
name: Architecture Document

View File

@@ -153,4 +153,4 @@ sections:
content: |
---
*Session facilitated using the BMAD-METHOD brainstorming framework*
*Session facilitated using the BMAD-METHOD brainstorming framework*

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
template:
id: brownfield-architecture-template-v2
name: Brownfield Enhancement Architecture
@@ -22,7 +23,7 @@ sections:
1. **Verify Complexity**: Confirm this enhancement requires architectural planning. For simple additions, recommend: "For simpler changes that don't require architectural planning, consider using the brownfield-create-epic or brownfield-create-story task with the Product Owner instead."
2. **REQUIRED INPUTS**:
- Completed brownfield-prd.md
- Completed prd.md
- Existing project technical documentation (from docs folder or user-provided)
- Access to existing project structure (IDE or uploaded files)
@@ -108,8 +109,8 @@ sections:
- **UI/UX Consistency:** {{ui_compatibility}}
- **Performance Impact:** {{performance_constraints}}
- id: tech-stack-alignment
title: Tech Stack Alignment
- id: tech-stack
title: Tech Stack
instruction: |
Ensure new components align with existing technology choices:
@@ -271,8 +272,8 @@ sections:
**Error Handling:** {{error_handling_strategy}}
- id: source-tree-integration
title: Source Tree Integration
- id: source-tree
title: Source Tree
instruction: |
Define how new code will integrate with existing project structure:
@@ -341,7 +342,7 @@ sections:
**Monitoring:** {{monitoring_approach}}
- id: coding-standards
title: Coding Standards and Conventions
title: Coding Standards
instruction: |
Ensure new code follows existing project conventions:

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
template:
id: brownfield-prd-template-v2
name: Brownfield Enhancement PRD

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
template:
id: competitor-analysis-template-v2
name: Competitive Analysis Report

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
template:
id: frontend-architecture-template-v2
name: Frontend Architecture Document

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
template:
id: frontend-spec-template-v2
name: UI/UX Specification

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
template:
id: fullstack-architecture-template-v2
name: Fullstack Architecture Document

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
template:
id: market-research-template-v2
name: Market Research Report

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
template:
id: prd-template-v2
name: Product Requirements Document

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
template:
id: project-brief-template-v2
name: Project Brief

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
template:
id: qa-gate-template-v1
name: Quality Gate Decision

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
template:
id: story-template-v2
name: Story Document

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
workflow:
id: brownfield-fullstack
name: Brownfield Full-Stack Enhancement
@@ -159,7 +160,7 @@ workflow:
- Dev Agent (New Chat): Address remaining items
- Return to QA for final approval
- repeat_development_cycle:
- step: repeat_development_cycle
action: continue_for_all_stories
notes: |
Repeat story cycle (SM → Dev → QA) for all epic stories
@@ -176,7 +177,7 @@ workflow:
- Validate epic was completed correctly
- Document learnings and improvements
- workflow_end:
- step: workflow_end
action: project_complete
notes: |
All stories implemented and reviewed!

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
workflow:
id: brownfield-service
name: Brownfield Service/API Enhancement
@@ -105,7 +106,7 @@ workflow:
- Dev Agent (New Chat): Address remaining items
- Return to QA for final approval
- repeat_development_cycle:
- step: repeat_development_cycle
action: continue_for_all_stories
notes: |
Repeat story cycle (SM → Dev → QA) for all epic stories
@@ -122,7 +123,7 @@ workflow:
- Validate epic was completed correctly
- Document learnings and improvements
- workflow_end:
- step: workflow_end
action: project_complete
notes: |
All stories implemented and reviewed!

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
workflow:
id: brownfield-ui
name: Brownfield UI/Frontend Enhancement
@@ -112,7 +113,7 @@ workflow:
- Dev Agent (New Chat): Address remaining items
- Return to QA for final approval
- repeat_development_cycle:
- step: repeat_development_cycle
action: continue_for_all_stories
notes: |
Repeat story cycle (SM → Dev → QA) for all epic stories
@@ -129,7 +130,7 @@ workflow:
- Validate epic was completed correctly
- Document learnings and improvements
- workflow_end:
- step: workflow_end
action: project_complete
notes: |
All stories implemented and reviewed!

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
workflow:
id: greenfield-fullstack
name: Greenfield Full-Stack Application Development
@@ -64,12 +65,12 @@ workflow:
condition: po_checklist_issues
notes: "If PO finds issues, return to relevant agent to fix and re-export updated documents to docs/ folder."
- project_setup_guidance:
- step: project_setup_guidance
action: guide_project_structure
condition: user_has_generated_ui
notes: "If user generated UI with v0/Lovable: For polyrepo setup, place downloaded project in separate frontend repo alongside backend repo. For monorepo, place in apps/web or packages/frontend directory. Review architecture document for specific guidance."
- development_order_guidance:
- step: development_order_guidance
action: guide_development_sequence
notes: "Based on PRD stories: If stories are frontend-heavy, start with frontend project/directory first. If backend-heavy or API-first, start with backend. For tightly coupled features, follow story sequence in monorepo setup. Reference sharded PRD epics for development order."
@@ -137,7 +138,7 @@ workflow:
- Dev Agent (New Chat): Address remaining items
- Return to QA for final approval
- repeat_development_cycle:
- step: repeat_development_cycle
action: continue_for_all_stories
notes: |
Repeat story cycle (SM → Dev → QA) for all epic stories
@@ -154,7 +155,7 @@ workflow:
- Validate epic was completed correctly
- Document learnings and improvements
- workflow_end:
- step: workflow_end
action: project_complete
notes: |
All stories implemented and reviewed!

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
workflow:
id: greenfield-service
name: Greenfield Service/API Development
@@ -113,7 +114,7 @@ workflow:
- Dev Agent (New Chat): Address remaining items
- Return to QA for final approval
- repeat_development_cycle:
- step: repeat_development_cycle
action: continue_for_all_stories
notes: |
Repeat story cycle (SM → Dev → QA) for all epic stories
@@ -130,7 +131,7 @@ workflow:
- Validate epic was completed correctly
- Document learnings and improvements
- workflow_end:
- step: workflow_end
action: project_complete
notes: |
All stories implemented and reviewed!

View File

@@ -1,3 +1,4 @@
# <!-- Powered by BMAD™ Core -->
workflow:
id: greenfield-ui
name: Greenfield UI/Frontend Development
@@ -63,7 +64,7 @@ workflow:
condition: po_checklist_issues
notes: "If PO finds issues, return to relevant agent to fix and re-export updated documents to docs/ folder."
- project_setup_guidance:
- step: project_setup_guidance
action: guide_project_structure
condition: user_has_generated_ui
notes: "If user generated UI with v0/Lovable: For polyrepo setup, place downloaded project in separate frontend repo. For monorepo, place in apps/web or frontend/ directory. Review architecture document for specific guidance."
@@ -132,7 +133,7 @@ workflow:
- Dev Agent (New Chat): Address remaining items
- Return to QA for final approval
- repeat_development_cycle:
- step: repeat_development_cycle
action: continue_for_all_stories
notes: |
Repeat story cycle (SM → Dev → QA) for all epic stories
@@ -149,7 +150,7 @@ workflow:
- Validate epic was completed correctly
- Document learnings and improvements
- workflow_end:
- step: workflow_end
action: project_complete
notes: |
All stories implemented and reviewed!

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Create Document from Template (YAML Driven)
## ⚠️ CRITICAL EXECUTION NOTICE ⚠️

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Checklist Validation Task
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# BMad Document Template Specification
## Overview

View File

@@ -1,3 +1,5 @@
<!-- Powered by BMAD™ Core -->
# Workflow Management
Enables BMad orchestrator to manage and execute team workflows.

View File

@@ -104,6 +104,7 @@ dependencies:
==================== END: .bmad-core/agents/analyst.md ====================
==================== START: .bmad-core/tasks/advanced-elicitation.md ====================
<!-- Powered by BMAD™ Core -->
# Advanced Elicitation Task
## Purpose
@@ -224,6 +225,7 @@ Choose a number (0-8) or 9 to proceed:
==================== END: .bmad-core/tasks/advanced-elicitation.md ====================
==================== START: .bmad-core/tasks/create-deep-research-prompt.md ====================
<!-- Powered by BMAD™ Core -->
# Create Deep Research Prompt Task
This task helps create comprehensive research prompts for various types of deep analysis. It can process inputs from brainstorming sessions, project briefs, market research, or specific research questions to generate targeted prompts for deeper investigation.
@@ -505,6 +507,7 @@ CRITICAL: collaborate with the user to develop specific, actionable research que
==================== END: .bmad-core/tasks/create-deep-research-prompt.md ====================
==================== START: .bmad-core/tasks/create-doc.md ====================
<!-- Powered by BMAD™ Core -->
# Create Document from Template (YAML Driven)
## ⚠️ CRITICAL EXECUTION NOTICE ⚠️
@@ -609,6 +612,7 @@ User can type `#yolo` to toggle to YOLO mode (process all sections at once).
==================== END: .bmad-core/tasks/create-doc.md ====================
==================== START: .bmad-core/tasks/document-project.md ====================
<!-- Powered by BMAD™ Core -->
# Document an Existing Project
## Purpose
@@ -955,6 +959,7 @@ Apply the advanced elicitation task after major sections to refine based on user
==================== END: .bmad-core/tasks/document-project.md ====================
==================== START: .bmad-core/tasks/facilitate-brainstorming-session.md ====================
<!-- Powered by BMAD™ Core -->
---
docOutputLocation: docs/brainstorming-session-results.md
template: '.bmad-core/templates/brainstorming-output-tmpl.yaml'
@@ -1249,10 +1254,11 @@ sections:
content: |
---
*Session facilitated using the BMAD-METHOD brainstorming framework*
*Session facilitated using the BMAD-METHOD brainstorming framework*
==================== END: .bmad-core/templates/brainstorming-output-tmpl.yaml ====================
==================== START: .bmad-core/templates/competitor-analysis-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: competitor-analysis-template-v2
name: Competitive Analysis Report
@@ -1562,6 +1568,7 @@ sections:
==================== END: .bmad-core/templates/competitor-analysis-tmpl.yaml ====================
==================== START: .bmad-core/templates/market-research-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: market-research-template-v2
name: Market Research Report
@@ -1817,6 +1824,7 @@ sections:
==================== END: .bmad-core/templates/market-research-tmpl.yaml ====================
==================== START: .bmad-core/templates/project-brief-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: project-brief-template-v2
name: Project Brief
@@ -2041,11 +2049,12 @@ sections:
==================== END: .bmad-core/templates/project-brief-tmpl.yaml ====================
==================== START: .bmad-core/data/bmad-kb.md ====================
# BMad Knowledge Base
<!-- Powered by BMAD™ Core -->
# BMAD™ Knowledge Base
## Overview
BMad-Method (Breakthrough Method of Agile AI-driven Development) is a framework that combines AI agents with Agile development methodologies. The v4 system introduces a modular architecture with improved dependency management, bundle optimization, and support for both web and IDE environments.
BMAD-METHOD™ (Breakthrough Method of Agile AI-driven Development) is a framework that combines AI agents with Agile development methodologies. The v4 system introduces a modular architecture with improved dependency management, bundle optimization, and support for both web and IDE environments.
### Key Features
@@ -2144,7 +2153,7 @@ npx bmad-method install
- **Roo Code**: Web-based IDE with agent support
- **GitHub Copilot**: VS Code extension with AI peer programming assistant
**Note for VS Code Users**: BMad-Method assumes when you mention "VS Code" that you're using it with an AI-powered extension like GitHub Copilot, Cline, or Roo. Standard VS Code without AI capabilities cannot run BMad agents. The installer includes built-in support for Cline and Roo.
**Note for VS Code Users**: BMAD-METHOD™ assumes when you mention "VS Code" that you're using it with an AI-powered extension like GitHub Copilot, Cline, or Roo. Standard VS Code without AI capabilities cannot run BMad agents. The installer includes built-in support for Cline and Roo.
**Verify Installation**:
@@ -2152,7 +2161,7 @@ npx bmad-method install
- IDE-specific integration files created
- All agent commands/rules/modes available
**Remember**: At its core, BMad-Method is about mastering and harnessing prompt engineering. Any IDE with AI agent support can use BMad - the framework provides the structured prompts and workflows that make AI development effective
**Remember**: At its core, BMAD-METHOD™ is about mastering and harnessing prompt engineering. Any IDE with AI agent support can use BMad - the framework provides the structured prompts and workflows that make AI development effective
### Environment Selection Guide
@@ -2221,7 +2230,7 @@ npx bmad-method install
## Core Configuration (core-config.yaml)
**New in V4**: The `bmad-core/core-config.yaml` file is a critical innovation that enables BMad to work seamlessly with any project structure, providing maximum flexibility and backwards compatibility.
**New in V4**: The `.bmad-core/core-config.yaml` file is a critical innovation that enables BMad to work seamlessly with any project structure, providing maximum flexibility and backwards compatibility.
### What is core-config.yaml?
@@ -2396,7 +2405,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
### System Overview
The BMad-Method is built around a modular architecture centered on the `bmad-core` directory, which serves as the brain of the entire system. This design enables the framework to operate effectively in both IDE environments (like Cursor, VS Code) and web-based AI interfaces (like ChatGPT, Gemini).
The BMAD-METHOD™ is built around a modular architecture centered on the `bmad-core` directory, which serves as the brain of the entire system. This design enables the framework to operate effectively in both IDE environments (like Cursor, VS Code) and web-based AI interfaces (like ChatGPT, Gemini).
### Key Architectural Components
@@ -2751,7 +2760,7 @@ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sh
- **Keep conversations focused** - One agent, one task per conversation
- **Review everything** - Always review and approve before marking complete
## Contributing to BMad-Method
## Contributing to BMAD-METHOD™
### Quick Contribution Guidelines
@@ -2783,7 +2792,7 @@ For full details, see `CONTRIBUTING.md`. Key points:
### What Are Expansion Packs?
Expansion packs extend BMad-Method beyond traditional software development into ANY domain. They provide specialized agent teams, templates, and workflows while keeping the core framework lean and focused on development.
Expansion packs extend BMAD-METHOD™ beyond traditional software development into ANY domain. They provide specialized agent teams, templates, and workflows while keeping the core framework lean and focused on development.
### Why Use Expansion Packs?
@@ -2850,6 +2859,7 @@ Use the **expansion-creator** pack to build your own:
==================== END: .bmad-core/data/bmad-kb.md ====================
==================== START: .bmad-core/data/brainstorming-techniques.md ====================
<!-- Powered by BMAD™ Core -->
# Brainstorming Techniques Data
## Creative Expansion

View File

@@ -105,6 +105,7 @@ dependencies:
==================== END: .bmad-core/agents/architect.md ====================
==================== START: .bmad-core/tasks/create-deep-research-prompt.md ====================
<!-- Powered by BMAD™ Core -->
# Create Deep Research Prompt Task
This task helps create comprehensive research prompts for various types of deep analysis. It can process inputs from brainstorming sessions, project briefs, market research, or specific research questions to generate targeted prompts for deeper investigation.
@@ -386,6 +387,7 @@ CRITICAL: collaborate with the user to develop specific, actionable research que
==================== END: .bmad-core/tasks/create-deep-research-prompt.md ====================
==================== START: .bmad-core/tasks/create-doc.md ====================
<!-- Powered by BMAD™ Core -->
# Create Document from Template (YAML Driven)
## ⚠️ CRITICAL EXECUTION NOTICE ⚠️
@@ -490,6 +492,7 @@ User can type `#yolo` to toggle to YOLO mode (process all sections at once).
==================== END: .bmad-core/tasks/create-doc.md ====================
==================== START: .bmad-core/tasks/document-project.md ====================
<!-- Powered by BMAD™ Core -->
# Document an Existing Project
## Purpose
@@ -836,6 +839,7 @@ Apply the advanced elicitation task after major sections to refine based on user
==================== END: .bmad-core/tasks/document-project.md ====================
==================== START: .bmad-core/tasks/execute-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Checklist Validation Task
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
@@ -925,6 +929,7 @@ The LLM will:
==================== END: .bmad-core/tasks/execute-checklist.md ====================
==================== START: .bmad-core/templates/architecture-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: architecture-template-v2
name: Architecture Document
@@ -1578,6 +1583,7 @@ sections:
==================== END: .bmad-core/templates/architecture-tmpl.yaml ====================
==================== START: .bmad-core/templates/brownfield-architecture-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: brownfield-architecture-template-v2
name: Brownfield Enhancement Architecture
@@ -1602,7 +1608,7 @@ sections:
1. **Verify Complexity**: Confirm this enhancement requires architectural planning. For simple additions, recommend: "For simpler changes that don't require architectural planning, consider using the brownfield-create-epic or brownfield-create-story task with the Product Owner instead."
2. **REQUIRED INPUTS**:
- Completed brownfield-prd.md
- Completed prd.md
- Existing project technical documentation (from docs folder or user-provided)
- Access to existing project structure (IDE or uploaded files)
@@ -2057,6 +2063,7 @@ sections:
==================== END: .bmad-core/templates/brownfield-architecture-tmpl.yaml ====================
==================== START: .bmad-core/templates/front-end-architecture-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: frontend-architecture-template-v2
name: Frontend Architecture Document
@@ -2278,6 +2285,7 @@ sections:
==================== END: .bmad-core/templates/front-end-architecture-tmpl.yaml ====================
==================== START: .bmad-core/templates/fullstack-architecture-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: fullstack-architecture-template-v2
name: Fullstack Architecture Document
@@ -3104,6 +3112,7 @@ sections:
==================== END: .bmad-core/templates/fullstack-architecture-tmpl.yaml ====================
==================== START: .bmad-core/checklists/architect-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Architect Solution Validation Checklist
This checklist serves as a comprehensive framework for the Architect to validate the technical design and architecture before development execution. The Architect should systematically work through each item, ensuring the architecture is robust, scalable, secure, and aligned with the product requirements.
@@ -3545,6 +3554,7 @@ After presenting the report, ask the user if they would like detailed analysis o
==================== END: .bmad-core/checklists/architect-checklist.md ====================
==================== START: .bmad-core/data/technical-preferences.md ====================
<!-- Powered by BMAD™ Core -->
# User-Defined Preferred Patterns and Preferences
None Listed

View File

@@ -127,6 +127,7 @@ dependencies:
==================== END: .bmad-core/agents/bmad-master.md ====================
==================== START: .bmad-core/tasks/advanced-elicitation.md ====================
<!-- Powered by BMAD™ Core -->
# Advanced Elicitation Task
## Purpose
@@ -247,6 +248,7 @@ Choose a number (0-8) or 9 to proceed:
==================== END: .bmad-core/tasks/advanced-elicitation.md ====================
==================== START: .bmad-core/tasks/brownfield-create-epic.md ====================
<!-- Powered by BMAD™ Core -->
# Create Brownfield Epic Task
## Purpose
@@ -410,6 +412,7 @@ The epic creation is successful when:
==================== END: .bmad-core/tasks/brownfield-create-epic.md ====================
==================== START: .bmad-core/tasks/brownfield-create-story.md ====================
<!-- Powered by BMAD™ Core -->
# Create Brownfield Story Task
## Purpose
@@ -560,6 +563,7 @@ The story creation is successful when:
==================== END: .bmad-core/tasks/brownfield-create-story.md ====================
==================== START: .bmad-core/tasks/correct-course.md ====================
<!-- Powered by BMAD™ Core -->
# Correct Course Task
## Purpose
@@ -633,6 +637,7 @@ The story creation is successful when:
==================== END: .bmad-core/tasks/correct-course.md ====================
==================== START: .bmad-core/tasks/create-deep-research-prompt.md ====================
<!-- Powered by BMAD™ Core -->
# Create Deep Research Prompt Task
This task helps create comprehensive research prompts for various types of deep analysis. It can process inputs from brainstorming sessions, project briefs, market research, or specific research questions to generate targeted prompts for deeper investigation.
@@ -914,6 +919,7 @@ CRITICAL: collaborate with the user to develop specific, actionable research que
==================== END: .bmad-core/tasks/create-deep-research-prompt.md ====================
==================== START: .bmad-core/tasks/create-doc.md ====================
<!-- Powered by BMAD™ Core -->
# Create Document from Template (YAML Driven)
## ⚠️ CRITICAL EXECUTION NOTICE ⚠️
@@ -1018,6 +1024,7 @@ User can type `#yolo` to toggle to YOLO mode (process all sections at once).
==================== END: .bmad-core/tasks/create-doc.md ====================
==================== START: .bmad-core/tasks/create-next-story.md ====================
<!-- Powered by BMAD™ Core -->
# Create Next Story Task
## Purpose
@@ -1133,6 +1140,7 @@ ALWAYS cite source documents: `[Source: architecture/{filename}.md#{section}]`
==================== END: .bmad-core/tasks/create-next-story.md ====================
==================== START: .bmad-core/tasks/document-project.md ====================
<!-- Powered by BMAD™ Core -->
# Document an Existing Project
## Purpose
@@ -1479,6 +1487,7 @@ Apply the advanced elicitation task after major sections to refine based on user
==================== END: .bmad-core/tasks/document-project.md ====================
==================== START: .bmad-core/tasks/execute-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Checklist Validation Task
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
@@ -1568,6 +1577,7 @@ The LLM will:
==================== END: .bmad-core/tasks/execute-checklist.md ====================
==================== START: .bmad-core/tasks/facilitate-brainstorming-session.md ====================
<!-- Powered by BMAD™ Core -->
---
docOutputLocation: docs/brainstorming-session-results.md
template: '.bmad-core/templates/brainstorming-output-tmpl.yaml'
@@ -1707,6 +1717,7 @@ Generate structured document with these sections:
==================== END: .bmad-core/tasks/facilitate-brainstorming-session.md ====================
==================== START: .bmad-core/tasks/generate-ai-frontend-prompt.md ====================
<!-- Powered by BMAD™ Core -->
# Create AI Frontend Prompt Task
## Purpose
@@ -1761,6 +1772,7 @@ You will now synthesize the inputs and the above principles into a final, compre
==================== END: .bmad-core/tasks/generate-ai-frontend-prompt.md ====================
==================== START: .bmad-core/tasks/index-docs.md ====================
<!-- Powered by BMAD™ Core -->
# Index Documentation Task
## Purpose
@@ -1937,6 +1949,7 @@ Would you like to proceed with documentation indexing? Please provide the requir
==================== END: .bmad-core/tasks/index-docs.md ====================
==================== START: .bmad-core/tasks/shard-doc.md ====================
<!-- Powered by BMAD™ Core -->
# Document Sharding Task
## Purpose
@@ -2125,6 +2138,7 @@ Document sharded successfully:
==================== END: .bmad-core/tasks/shard-doc.md ====================
==================== START: .bmad-core/templates/architecture-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: architecture-template-v2
name: Architecture Document
@@ -2778,6 +2792,7 @@ sections:
==================== END: .bmad-core/templates/architecture-tmpl.yaml ====================
==================== START: .bmad-core/templates/brownfield-architecture-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: brownfield-architecture-template-v2
name: Brownfield Enhancement Architecture
@@ -2802,7 +2817,7 @@ sections:
1. **Verify Complexity**: Confirm this enhancement requires architectural planning. For simple additions, recommend: "For simpler changes that don't require architectural planning, consider using the brownfield-create-epic or brownfield-create-story task with the Product Owner instead."
2. **REQUIRED INPUTS**:
- Completed brownfield-prd.md
- Completed prd.md
- Existing project technical documentation (from docs folder or user-provided)
- Access to existing project structure (IDE or uploaded files)
@@ -3257,6 +3272,7 @@ sections:
==================== END: .bmad-core/templates/brownfield-architecture-tmpl.yaml ====================
==================== START: .bmad-core/templates/brownfield-prd-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: brownfield-prd-template-v2
name: Brownfield Enhancement PRD
@@ -3540,6 +3556,7 @@ sections:
==================== END: .bmad-core/templates/brownfield-prd-tmpl.yaml ====================
==================== START: .bmad-core/templates/competitor-analysis-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: competitor-analysis-template-v2
name: Competitive Analysis Report
@@ -3849,6 +3866,7 @@ sections:
==================== END: .bmad-core/templates/competitor-analysis-tmpl.yaml ====================
==================== START: .bmad-core/templates/front-end-architecture-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: frontend-architecture-template-v2
name: Frontend Architecture Document
@@ -4070,6 +4088,7 @@ sections:
==================== END: .bmad-core/templates/front-end-architecture-tmpl.yaml ====================
==================== START: .bmad-core/templates/front-end-spec-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: frontend-spec-template-v2
name: UI/UX Specification
@@ -4422,6 +4441,7 @@ sections:
==================== END: .bmad-core/templates/front-end-spec-tmpl.yaml ====================
==================== START: .bmad-core/templates/fullstack-architecture-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: fullstack-architecture-template-v2
name: Fullstack Architecture Document
@@ -5248,6 +5268,7 @@ sections:
==================== END: .bmad-core/templates/fullstack-architecture-tmpl.yaml ====================
==================== START: .bmad-core/templates/market-research-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: market-research-template-v2
name: Market Research Report
@@ -5503,6 +5524,7 @@ sections:
==================== END: .bmad-core/templates/market-research-tmpl.yaml ====================
==================== START: .bmad-core/templates/prd-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: prd-template-v2
name: Product Requirements Document
@@ -5708,6 +5730,7 @@ sections:
==================== END: .bmad-core/templates/prd-tmpl.yaml ====================
==================== START: .bmad-core/templates/project-brief-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: project-brief-template-v2
name: Project Brief
@@ -5932,6 +5955,7 @@ sections:
==================== END: .bmad-core/templates/project-brief-tmpl.yaml ====================
==================== START: .bmad-core/templates/story-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: story-template-v2
name: Story Document
@@ -6072,6 +6096,7 @@ sections:
==================== END: .bmad-core/templates/story-tmpl.yaml ====================
==================== START: .bmad-core/checklists/architect-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Architect Solution Validation Checklist
This checklist serves as a comprehensive framework for the Architect to validate the technical design and architecture before development execution. The Architect should systematically work through each item, ensuring the architecture is robust, scalable, secure, and aligned with the product requirements.
@@ -6513,6 +6538,7 @@ After presenting the report, ask the user if they would like detailed analysis o
==================== END: .bmad-core/checklists/architect-checklist.md ====================
==================== START: .bmad-core/checklists/change-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Change Navigation Checklist
**Purpose:** To systematically guide the selected Agent and user through the analysis and planning required when a significant change (pivot, tech issue, missing requirement, failed story) is identified during the BMad workflow.
@@ -6698,6 +6724,7 @@ Keep it action-oriented and forward-looking.]]
==================== END: .bmad-core/checklists/change-checklist.md ====================
==================== START: .bmad-core/checklists/pm-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Product Manager (PM) Requirements Checklist
This checklist serves as a comprehensive framework to ensure the Product Requirements Document (PRD) and Epic definitions are complete, well-structured, and appropriately scoped for MVP development. The PM should systematically work through each item during the product definition process.
@@ -7071,6 +7098,7 @@ After presenting the report, ask if the user wants:
==================== END: .bmad-core/checklists/pm-checklist.md ====================
==================== START: .bmad-core/checklists/po-master-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Product Owner (PO) Master Validation Checklist
This checklist serves as a comprehensive framework for the Product Owner to validate project plans before development execution. It adapts intelligently based on project type (greenfield vs brownfield) and includes UI/UX considerations when applicable.
@@ -7086,7 +7114,7 @@ First, determine the project type by checking:
2. Is this a BROWNFIELD project (enhancing existing system)?
- Look for: References to existing codebase, enhancement/modification language
- Check for: brownfield-prd.md, brownfield-architecture.md, existing system analysis
- Check for: prd.md, architecture.md, existing system analysis
3. Does the project include UI/UX components?
- Check for: frontend-architecture.md, UI/UX specifications, design files
@@ -7104,8 +7132,8 @@ For GREENFIELD projects:
For BROWNFIELD projects:
- brownfield-prd.md - The brownfield enhancement requirements
- brownfield-architecture.md - The enhancement architecture
- prd.md - The brownfield enhancement requirements
- architecture.md - The enhancement architecture
- Existing project codebase access (CRITICAL - cannot proceed without this)
- Current deployment configuration and infrastructure details
- Database schemas, API documentation, monitoring setup
@@ -7506,6 +7534,7 @@ After presenting the report, ask if the user wants:
==================== END: .bmad-core/checklists/po-master-checklist.md ====================
==================== START: .bmad-core/checklists/story-dod-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Story Definition of Done (DoD) Checklist
## Instructions for Developer Agent
@@ -7603,6 +7632,7 @@ Be honest - it's better to flag issues now than have them discovered later.]]
==================== END: .bmad-core/checklists/story-dod-checklist.md ====================
==================== START: .bmad-core/checklists/story-draft-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Story Draft Checklist
The Scrum Master should use this checklist to validate that each story contains sufficient context for a developer agent to implement it successfully, while assuming the dev agent has reasonable capabilities to figure things out.
@@ -7759,11 +7789,12 @@ Be pragmatic - perfect documentation doesn't exist, but it must be enough to pro
==================== END: .bmad-core/checklists/story-draft-checklist.md ====================
==================== START: .bmad-core/data/bmad-kb.md ====================
# BMad Knowledge Base
<!-- Powered by BMAD™ Core -->
# BMAD™ Knowledge Base
## Overview
BMad-Method (Breakthrough Method of Agile AI-driven Development) is a framework that combines AI agents with Agile development methodologies. The v4 system introduces a modular architecture with improved dependency management, bundle optimization, and support for both web and IDE environments.
BMAD-METHOD™ (Breakthrough Method of Agile AI-driven Development) is a framework that combines AI agents with Agile development methodologies. The v4 system introduces a modular architecture with improved dependency management, bundle optimization, and support for both web and IDE environments.
### Key Features
@@ -7862,7 +7893,7 @@ npx bmad-method install
- **Roo Code**: Web-based IDE with agent support
- **GitHub Copilot**: VS Code extension with AI peer programming assistant
**Note for VS Code Users**: BMad-Method assumes when you mention "VS Code" that you're using it with an AI-powered extension like GitHub Copilot, Cline, or Roo. Standard VS Code without AI capabilities cannot run BMad agents. The installer includes built-in support for Cline and Roo.
**Note for VS Code Users**: BMAD-METHOD™ assumes when you mention "VS Code" that you're using it with an AI-powered extension like GitHub Copilot, Cline, or Roo. Standard VS Code without AI capabilities cannot run BMad agents. The installer includes built-in support for Cline and Roo.
**Verify Installation**:
@@ -7870,7 +7901,7 @@ npx bmad-method install
- IDE-specific integration files created
- All agent commands/rules/modes available
**Remember**: At its core, BMad-Method is about mastering and harnessing prompt engineering. Any IDE with AI agent support can use BMad - the framework provides the structured prompts and workflows that make AI development effective
**Remember**: At its core, BMAD-METHOD™ is about mastering and harnessing prompt engineering. Any IDE with AI agent support can use BMad - the framework provides the structured prompts and workflows that make AI development effective
### Environment Selection Guide
@@ -7939,7 +7970,7 @@ npx bmad-method install
## Core Configuration (core-config.yaml)
**New in V4**: The `bmad-core/core-config.yaml` file is a critical innovation that enables BMad to work seamlessly with any project structure, providing maximum flexibility and backwards compatibility.
**New in V4**: The `.bmad-core/core-config.yaml` file is a critical innovation that enables BMad to work seamlessly with any project structure, providing maximum flexibility and backwards compatibility.
### What is core-config.yaml?
@@ -8114,7 +8145,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
### System Overview
The BMad-Method is built around a modular architecture centered on the `bmad-core` directory, which serves as the brain of the entire system. This design enables the framework to operate effectively in both IDE environments (like Cursor, VS Code) and web-based AI interfaces (like ChatGPT, Gemini).
The BMAD-METHOD™ is built around a modular architecture centered on the `bmad-core` directory, which serves as the brain of the entire system. This design enables the framework to operate effectively in both IDE environments (like Cursor, VS Code) and web-based AI interfaces (like ChatGPT, Gemini).
### Key Architectural Components
@@ -8469,7 +8500,7 @@ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sh
- **Keep conversations focused** - One agent, one task per conversation
- **Review everything** - Always review and approve before marking complete
## Contributing to BMad-Method
## Contributing to BMAD-METHOD™
### Quick Contribution Guidelines
@@ -8501,7 +8532,7 @@ For full details, see `CONTRIBUTING.md`. Key points:
### What Are Expansion Packs?
Expansion packs extend BMad-Method beyond traditional software development into ANY domain. They provide specialized agent teams, templates, and workflows while keeping the core framework lean and focused on development.
Expansion packs extend BMAD-METHOD™ beyond traditional software development into ANY domain. They provide specialized agent teams, templates, and workflows while keeping the core framework lean and focused on development.
### Why Use Expansion Packs?
@@ -8568,6 +8599,7 @@ Use the **expansion-creator** pack to build your own:
==================== END: .bmad-core/data/bmad-kb.md ====================
==================== START: .bmad-core/data/brainstorming-techniques.md ====================
<!-- Powered by BMAD™ Core -->
# Brainstorming Techniques Data
## Creative Expansion
@@ -8607,6 +8639,7 @@ Use the **expansion-creator** pack to build your own:
==================== END: .bmad-core/data/brainstorming-techniques.md ====================
==================== START: .bmad-core/data/elicitation-methods.md ====================
<!-- Powered by BMAD™ Core -->
# Elicitation Methods Data
## Core Reflective Methods
@@ -8764,6 +8797,7 @@ Use the **expansion-creator** pack to build your own:
==================== END: .bmad-core/data/elicitation-methods.md ====================
==================== START: .bmad-core/data/technical-preferences.md ====================
<!-- Powered by BMAD™ Core -->
# User-Defined Preferred Patterns and Preferences
None Listed

View File

@@ -82,13 +82,8 @@ commands:
doc-out: Output full document
kb-mode: Load full BMad knowledge base
party-mode: Group chat with all agents
plan: Create detailed workflow plan before starting
plan-status: Show current workflow plan progress
plan-update: Update workflow plan status
status: Show current context, active agent, and progress
task: Run a specific task (list if name not specified)
workflow: Start a specific workflow (list if name not specified)
workflow-guidance: Get personalized help selecting the right workflow
yolo: Toggle skip confirmations mode
exit: Return to BMad or exit session
help-display-template: |
@@ -172,6 +167,7 @@ dependencies:
==================== END: .bmad-core/agents/bmad-orchestrator.md ====================
==================== START: .bmad-core/tasks/advanced-elicitation.md ====================
<!-- Powered by BMAD™ Core -->
# Advanced Elicitation Task
## Purpose
@@ -292,6 +288,7 @@ Choose a number (0-8) or 9 to proceed:
==================== END: .bmad-core/tasks/advanced-elicitation.md ====================
==================== START: .bmad-core/tasks/create-doc.md ====================
<!-- Powered by BMAD™ Core -->
# Create Document from Template (YAML Driven)
## ⚠️ CRITICAL EXECUTION NOTICE ⚠️
@@ -396,6 +393,7 @@ User can type `#yolo` to toggle to YOLO mode (process all sections at once).
==================== END: .bmad-core/tasks/create-doc.md ====================
==================== START: .bmad-core/tasks/kb-mode-interaction.md ====================
<!-- Powered by BMAD™ Core -->
# KB Mode Interaction Task
## Purpose
@@ -474,11 +472,12 @@ Or ask me about anything else related to BMad-Method!
==================== END: .bmad-core/tasks/kb-mode-interaction.md ====================
==================== START: .bmad-core/data/bmad-kb.md ====================
# BMad Knowledge Base
<!-- Powered by BMAD™ Core -->
# BMAD™ Knowledge Base
## Overview
BMad-Method (Breakthrough Method of Agile AI-driven Development) is a framework that combines AI agents with Agile development methodologies. The v4 system introduces a modular architecture with improved dependency management, bundle optimization, and support for both web and IDE environments.
BMAD-METHOD™ (Breakthrough Method of Agile AI-driven Development) is a framework that combines AI agents with Agile development methodologies. The v4 system introduces a modular architecture with improved dependency management, bundle optimization, and support for both web and IDE environments.
### Key Features
@@ -577,7 +576,7 @@ npx bmad-method install
- **Roo Code**: Web-based IDE with agent support
- **GitHub Copilot**: VS Code extension with AI peer programming assistant
**Note for VS Code Users**: BMad-Method assumes when you mention "VS Code" that you're using it with an AI-powered extension like GitHub Copilot, Cline, or Roo. Standard VS Code without AI capabilities cannot run BMad agents. The installer includes built-in support for Cline and Roo.
**Note for VS Code Users**: BMAD-METHOD™ assumes when you mention "VS Code" that you're using it with an AI-powered extension like GitHub Copilot, Cline, or Roo. Standard VS Code without AI capabilities cannot run BMad agents. The installer includes built-in support for Cline and Roo.
**Verify Installation**:
@@ -585,7 +584,7 @@ npx bmad-method install
- IDE-specific integration files created
- All agent commands/rules/modes available
**Remember**: At its core, BMad-Method is about mastering and harnessing prompt engineering. Any IDE with AI agent support can use BMad - the framework provides the structured prompts and workflows that make AI development effective
**Remember**: At its core, BMAD-METHOD™ is about mastering and harnessing prompt engineering. Any IDE with AI agent support can use BMad - the framework provides the structured prompts and workflows that make AI development effective
### Environment Selection Guide
@@ -654,7 +653,7 @@ npx bmad-method install
## Core Configuration (core-config.yaml)
**New in V4**: The `bmad-core/core-config.yaml` file is a critical innovation that enables BMad to work seamlessly with any project structure, providing maximum flexibility and backwards compatibility.
**New in V4**: The `.bmad-core/core-config.yaml` file is a critical innovation that enables BMad to work seamlessly with any project structure, providing maximum flexibility and backwards compatibility.
### What is core-config.yaml?
@@ -829,7 +828,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
### System Overview
The BMad-Method is built around a modular architecture centered on the `bmad-core` directory, which serves as the brain of the entire system. This design enables the framework to operate effectively in both IDE environments (like Cursor, VS Code) and web-based AI interfaces (like ChatGPT, Gemini).
The BMAD-METHOD™ is built around a modular architecture centered on the `bmad-core` directory, which serves as the brain of the entire system. This design enables the framework to operate effectively in both IDE environments (like Cursor, VS Code) and web-based AI interfaces (like ChatGPT, Gemini).
### Key Architectural Components
@@ -1184,7 +1183,7 @@ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sh
- **Keep conversations focused** - One agent, one task per conversation
- **Review everything** - Always review and approve before marking complete
## Contributing to BMad-Method
## Contributing to BMAD-METHOD™
### Quick Contribution Guidelines
@@ -1216,7 +1215,7 @@ For full details, see `CONTRIBUTING.md`. Key points:
### What Are Expansion Packs?
Expansion packs extend BMad-Method beyond traditional software development into ANY domain. They provide specialized agent teams, templates, and workflows while keeping the core framework lean and focused on development.
Expansion packs extend BMAD-METHOD™ beyond traditional software development into ANY domain. They provide specialized agent teams, templates, and workflows while keeping the core framework lean and focused on development.
### Why Use Expansion Packs?
@@ -1283,6 +1282,7 @@ Use the **expansion-creator** pack to build your own:
==================== END: .bmad-core/data/bmad-kb.md ====================
==================== START: .bmad-core/data/elicitation-methods.md ====================
<!-- Powered by BMAD™ Core -->
# Elicitation Methods Data
## Core Reflective Methods
@@ -1440,6 +1440,7 @@ Use the **expansion-creator** pack to build your own:
==================== END: .bmad-core/data/elicitation-methods.md ====================
==================== START: .bmad-core/utils/workflow-management.md ====================
<!-- Powered by BMAD™ Core -->
# Workflow Management
Enables BMad orchestrator to manage and execute team workflows.

12
dist/agents/dev.txt vendored
View File

@@ -93,6 +93,7 @@ dependencies:
==================== END: .bmad-core/agents/dev.md ====================
==================== START: .bmad-core/tasks/apply-qa-fixes.md ====================
<!-- Powered by BMAD™ Core -->
# apply-qa-fixes
Implement fixes based on QA results (gate and assessments) for a specific story. This task is for the Dev agent to systematically consume QA outputs and apply code/test changes while only updating allowed sections in the story file.
@@ -109,8 +110,8 @@ Implement fixes based on QA results (gate and assessments) for a specific story.
```yaml
required:
- story_id: '{epic}.{story}' # e.g., "2.2"
- qa_root: from `bmad-core/core-config.yaml` key `qa.qaLocation` (e.g., `docs/project/qa`)
- story_root: from `bmad-core/core-config.yaml` key `devStoryLocation` (e.g., `docs/project/stories`)
- qa_root: from `.bmad-core/core-config.yaml` key `qa.qaLocation` (e.g., `docs/project/qa`)
- story_root: from `.bmad-core/core-config.yaml` key `devStoryLocation` (e.g., `docs/project/stories`)
optional:
- story_title: '{title}' # derive from story H1 if missing
@@ -138,7 +139,7 @@ optional:
### 0) Load Core Config & Locate Story
- Read `bmad-core/core-config.yaml` and resolve `qa_root` and `story_root`
- Read `.bmad-core/core-config.yaml` and resolve `qa_root` and `story_root`
- Locate story file in `{story_root}/{epic}.{story}.*.md`
- HALT if missing and ask for correct story id/path
@@ -206,7 +207,7 @@ Status Rule:
## Blocking Conditions
- Missing `bmad-core/core-config.yaml`
- Missing `.bmad-core/core-config.yaml`
- Story file not found for `story_id`
- No QA artifacts found (neither gate nor assessments)
- HALT and request QA to generate at least a gate file (or proceed only with clear developer-provided fix list)
@@ -244,6 +245,7 @@ Fix plan:
==================== END: .bmad-core/tasks/apply-qa-fixes.md ====================
==================== START: .bmad-core/tasks/execute-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Checklist Validation Task
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
@@ -333,6 +335,7 @@ The LLM will:
==================== END: .bmad-core/tasks/execute-checklist.md ====================
==================== START: .bmad-core/tasks/validate-next-story.md ====================
<!-- Powered by BMAD™ Core -->
# Validate Next Story Task
## Purpose
@@ -470,6 +473,7 @@ Provide a structured validation report including:
==================== END: .bmad-core/tasks/validate-next-story.md ====================
==================== START: .bmad-core/checklists/story-dod-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Story Definition of Done (DoD) Checklist
## Instructions for Developer Agent

12
dist/agents/pm.txt vendored
View File

@@ -104,6 +104,7 @@ dependencies:
==================== END: .bmad-core/agents/pm.md ====================
==================== START: .bmad-core/tasks/brownfield-create-epic.md ====================
<!-- Powered by BMAD™ Core -->
# Create Brownfield Epic Task
## Purpose
@@ -267,6 +268,7 @@ The epic creation is successful when:
==================== END: .bmad-core/tasks/brownfield-create-epic.md ====================
==================== START: .bmad-core/tasks/brownfield-create-story.md ====================
<!-- Powered by BMAD™ Core -->
# Create Brownfield Story Task
## Purpose
@@ -417,6 +419,7 @@ The story creation is successful when:
==================== END: .bmad-core/tasks/brownfield-create-story.md ====================
==================== START: .bmad-core/tasks/correct-course.md ====================
<!-- Powered by BMAD™ Core -->
# Correct Course Task
## Purpose
@@ -490,6 +493,7 @@ The story creation is successful when:
==================== END: .bmad-core/tasks/correct-course.md ====================
==================== START: .bmad-core/tasks/create-deep-research-prompt.md ====================
<!-- Powered by BMAD™ Core -->
# Create Deep Research Prompt Task
This task helps create comprehensive research prompts for various types of deep analysis. It can process inputs from brainstorming sessions, project briefs, market research, or specific research questions to generate targeted prompts for deeper investigation.
@@ -771,6 +775,7 @@ CRITICAL: collaborate with the user to develop specific, actionable research que
==================== END: .bmad-core/tasks/create-deep-research-prompt.md ====================
==================== START: .bmad-core/tasks/create-doc.md ====================
<!-- Powered by BMAD™ Core -->
# Create Document from Template (YAML Driven)
## ⚠️ CRITICAL EXECUTION NOTICE ⚠️
@@ -875,6 +880,7 @@ User can type `#yolo` to toggle to YOLO mode (process all sections at once).
==================== END: .bmad-core/tasks/create-doc.md ====================
==================== START: .bmad-core/tasks/execute-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Checklist Validation Task
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
@@ -964,6 +970,7 @@ The LLM will:
==================== END: .bmad-core/tasks/execute-checklist.md ====================
==================== START: .bmad-core/tasks/shard-doc.md ====================
<!-- Powered by BMAD™ Core -->
# Document Sharding Task
## Purpose
@@ -1152,6 +1159,7 @@ Document sharded successfully:
==================== END: .bmad-core/tasks/shard-doc.md ====================
==================== START: .bmad-core/templates/brownfield-prd-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: brownfield-prd-template-v2
name: Brownfield Enhancement PRD
@@ -1435,6 +1443,7 @@ sections:
==================== END: .bmad-core/templates/brownfield-prd-tmpl.yaml ====================
==================== START: .bmad-core/templates/prd-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: prd-template-v2
name: Product Requirements Document
@@ -1640,6 +1649,7 @@ sections:
==================== END: .bmad-core/templates/prd-tmpl.yaml ====================
==================== START: .bmad-core/checklists/change-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Change Navigation Checklist
**Purpose:** To systematically guide the selected Agent and user through the analysis and planning required when a significant change (pivot, tech issue, missing requirement, failed story) is identified during the BMad workflow.
@@ -1825,6 +1835,7 @@ Keep it action-oriented and forward-looking.]]
==================== END: .bmad-core/checklists/change-checklist.md ====================
==================== START: .bmad-core/checklists/pm-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Product Manager (PM) Requirements Checklist
This checklist serves as a comprehensive framework to ensure the Product Requirements Document (PRD) and Epic definitions are complete, well-structured, and appropriately scoped for MVP development. The PM should systematically work through each item during the product definition process.
@@ -2198,6 +2209,7 @@ After presenting the report, ask if the user wants:
==================== END: .bmad-core/checklists/pm-checklist.md ====================
==================== START: .bmad-core/data/technical-preferences.md ====================
<!-- Powered by BMAD™ Core -->
# User-Defined Preferred Patterns and Preferences
None Listed

13
dist/agents/po.txt vendored
View File

@@ -99,6 +99,7 @@ dependencies:
==================== END: .bmad-core/agents/po.md ====================
==================== START: .bmad-core/tasks/correct-course.md ====================
<!-- Powered by BMAD™ Core -->
# Correct Course Task
## Purpose
@@ -172,6 +173,7 @@ dependencies:
==================== END: .bmad-core/tasks/correct-course.md ====================
==================== START: .bmad-core/tasks/execute-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Checklist Validation Task
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
@@ -261,6 +263,7 @@ The LLM will:
==================== END: .bmad-core/tasks/execute-checklist.md ====================
==================== START: .bmad-core/tasks/shard-doc.md ====================
<!-- Powered by BMAD™ Core -->
# Document Sharding Task
## Purpose
@@ -449,6 +452,7 @@ Document sharded successfully:
==================== END: .bmad-core/tasks/shard-doc.md ====================
==================== START: .bmad-core/tasks/validate-next-story.md ====================
<!-- Powered by BMAD™ Core -->
# Validate Next Story Task
## Purpose
@@ -586,6 +590,7 @@ Provide a structured validation report including:
==================== END: .bmad-core/tasks/validate-next-story.md ====================
==================== START: .bmad-core/templates/story-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: story-template-v2
name: Story Document
@@ -726,6 +731,7 @@ sections:
==================== END: .bmad-core/templates/story-tmpl.yaml ====================
==================== START: .bmad-core/checklists/change-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Change Navigation Checklist
**Purpose:** To systematically guide the selected Agent and user through the analysis and planning required when a significant change (pivot, tech issue, missing requirement, failed story) is identified during the BMad workflow.
@@ -911,6 +917,7 @@ Keep it action-oriented and forward-looking.]]
==================== END: .bmad-core/checklists/change-checklist.md ====================
==================== START: .bmad-core/checklists/po-master-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Product Owner (PO) Master Validation Checklist
This checklist serves as a comprehensive framework for the Product Owner to validate project plans before development execution. It adapts intelligently based on project type (greenfield vs brownfield) and includes UI/UX considerations when applicable.
@@ -926,7 +933,7 @@ First, determine the project type by checking:
2. Is this a BROWNFIELD project (enhancing existing system)?
- Look for: References to existing codebase, enhancement/modification language
- Check for: brownfield-prd.md, brownfield-architecture.md, existing system analysis
- Check for: prd.md, architecture.md, existing system analysis
3. Does the project include UI/UX components?
- Check for: frontend-architecture.md, UI/UX specifications, design files
@@ -944,8 +951,8 @@ For GREENFIELD projects:
For BROWNFIELD projects:
- brownfield-prd.md - The brownfield enhancement requirements
- brownfield-architecture.md - The enhancement architecture
- prd.md - The brownfield enhancement requirements
- architecture.md - The enhancement architecture
- Existing project codebase access (CRITICAL - cannot proceed without this)
- Current deployment configuration and infrastructure details
- Database schemas, API documentation, monitoring setup

24
dist/agents/qa.txt vendored
View File

@@ -55,8 +55,7 @@ agent:
id: qa
title: Test Architect & Quality Advisor
icon: 🧪
whenToUse: |
Use for comprehensive test architecture review, quality gate decisions,
whenToUse: Use for comprehensive test architecture review, quality gate decisions,
and code improvement. Provides thorough analysis including requirements
traceability, risk assessment, and test strategy.
Advisory only - teams choose their quality bar.
@@ -111,6 +110,7 @@ dependencies:
==================== END: .bmad-core/agents/qa.md ====================
==================== START: .bmad-core/tasks/nfr-assess.md ====================
<!-- Powered by BMAD™ Core -->
# nfr-assess
Quick NFR validation focused on the core four: security, performance, reliability, maintainability.
@@ -120,11 +120,11 @@ Quick NFR validation focused on the core four: security, performance, reliabilit
```yaml
required:
- story_id: '{epic}.{story}' # e.g., "1.3"
- story_path: `bmad-core/core-config.yaml` for the `devStoryLocation`
- story_path: `.bmad-core/core-config.yaml` for the `devStoryLocation`
optional:
- architecture_refs: `bmad-core/core-config.yaml` for the `architecture.architectureFile`
- technical_preferences: `bmad-core/core-config.yaml` for the `technicalPreferences`
- architecture_refs: `.bmad-core/core-config.yaml` for the `architecture.architectureFile`
- technical_preferences: `.bmad-core/core-config.yaml` for the `technicalPreferences`
- acceptance_criteria: From story file
```
@@ -457,6 +457,7 @@ performance_deep_dive:
==================== END: .bmad-core/tasks/nfr-assess.md ====================
==================== START: .bmad-core/tasks/qa-gate.md ====================
<!-- Powered by BMAD™ Core -->
# qa-gate
Create or update a quality gate decision file for a story based on review findings.
@@ -473,7 +474,7 @@ Generate a standalone quality gate file that provides a clear pass/fail decision
## Gate File Location
**ALWAYS** check the `bmad-core/core-config.yaml` for the `qa.qaLocation/gates`
**ALWAYS** check the `.bmad-core/core-config.yaml` for the `qa.qaLocation/gates`
Slug rules:
@@ -583,7 +584,7 @@ waiver:
## Output Requirements
1. **ALWAYS** create gate file at: `qa.qaLocation/gates` from `bmad-core/core-config.yaml`
1. **ALWAYS** create gate file at: `qa.qaLocation/gates` from `.bmad-core/core-config.yaml`
2. **ALWAYS** append this exact format to story's QA Results section:
```text
@@ -621,6 +622,7 @@ Gate: CONCERNS → qa.qaLocation/gates/{epic}.{story}-{slug}.yml
==================== END: .bmad-core/tasks/qa-gate.md ====================
==================== START: .bmad-core/tasks/review-story.md ====================
<!-- Powered by BMAD™ Core -->
# review-story
Perform a comprehensive test architecture review with quality gate decision. This adaptive, risk-aware review creates both a story update and a detailed gate file.
@@ -807,7 +809,7 @@ NFR assessment: qa.qaLocation/assessments/{epic}.{story}-nfr-{YYYYMMDD}.md
**Template and Directory:**
- Render from `../templates/qa-gate-tmpl.yaml`
- Create directory defined in `qa.qaLocation/gates` (see `bmad-core/core-config.yaml`) if missing
- Create directory defined in `qa.qaLocation/gates` (see `.bmad-core/core-config.yaml`) if missing
- Save to: `qa.qaLocation/gates/{epic}.{story}-{slug}.yml`
Gate file structure:
@@ -938,6 +940,7 @@ After review:
==================== END: .bmad-core/tasks/review-story.md ====================
==================== START: .bmad-core/tasks/risk-profile.md ====================
<!-- Powered by BMAD™ Core -->
# risk-profile
Generate a comprehensive risk assessment matrix for a story implementation using probability × impact analysis.
@@ -1294,6 +1297,7 @@ Risk profile: qa.qaLocation/assessments/{epic}.{story}-risk-{YYYYMMDD}.md
==================== END: .bmad-core/tasks/risk-profile.md ====================
==================== START: .bmad-core/tasks/test-design.md ====================
<!-- Powered by BMAD™ Core -->
# test-design
Create comprehensive test scenarios with appropriate test level recommendations for story implementation.
@@ -1471,6 +1475,7 @@ Before finalizing, verify:
==================== END: .bmad-core/tasks/test-design.md ====================
==================== START: .bmad-core/tasks/trace-requirements.md ====================
<!-- Powered by BMAD™ Core -->
# trace-requirements
Map story requirements to test cases using Given-When-Then patterns for comprehensive traceability.
@@ -1738,6 +1743,7 @@ Trace matrix: qa.qaLocation/assessments/{epic}.{story}-trace-{YYYYMMDD}.md
==================== END: .bmad-core/tasks/trace-requirements.md ====================
==================== START: .bmad-core/templates/qa-gate-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: qa-gate-template-v1
name: Quality Gate Decision
@@ -1843,6 +1849,7 @@ optional_fields_examples:
==================== END: .bmad-core/templates/qa-gate-tmpl.yaml ====================
==================== START: .bmad-core/templates/story-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: story-template-v2
name: Story Document
@@ -1983,6 +1990,7 @@ sections:
==================== END: .bmad-core/templates/story-tmpl.yaml ====================
==================== START: .bmad-core/data/technical-preferences.md ====================
<!-- Powered by BMAD™ Core -->
# User-Defined Preferred Patterns and Preferences
None Listed

5
dist/agents/sm.txt vendored
View File

@@ -85,6 +85,7 @@ dependencies:
==================== END: .bmad-core/agents/sm.md ====================
==================== START: .bmad-core/tasks/correct-course.md ====================
<!-- Powered by BMAD™ Core -->
# Correct Course Task
## Purpose
@@ -158,6 +159,7 @@ dependencies:
==================== END: .bmad-core/tasks/correct-course.md ====================
==================== START: .bmad-core/tasks/create-next-story.md ====================
<!-- Powered by BMAD™ Core -->
# Create Next Story Task
## Purpose
@@ -273,6 +275,7 @@ ALWAYS cite source documents: `[Source: architecture/{filename}.md#{section}]`
==================== END: .bmad-core/tasks/create-next-story.md ====================
==================== START: .bmad-core/tasks/execute-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Checklist Validation Task
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
@@ -362,6 +365,7 @@ The LLM will:
==================== END: .bmad-core/tasks/execute-checklist.md ====================
==================== START: .bmad-core/templates/story-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: story-template-v2
name: Story Document
@@ -502,6 +506,7 @@ sections:
==================== END: .bmad-core/templates/story-tmpl.yaml ====================
==================== START: .bmad-core/checklists/story-draft-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Story Draft Checklist
The Scrum Master should use this checklist to validate that each story contains sufficient context for a developer agent to implement it successfully, while assuming the dev agent has reasonable capabilities to figure things out.

View File

@@ -89,6 +89,7 @@ dependencies:
==================== END: .bmad-core/agents/ux-expert.md ====================
==================== START: .bmad-core/tasks/create-doc.md ====================
<!-- Powered by BMAD™ Core -->
# Create Document from Template (YAML Driven)
## ⚠️ CRITICAL EXECUTION NOTICE ⚠️
@@ -193,6 +194,7 @@ User can type `#yolo` to toggle to YOLO mode (process all sections at once).
==================== END: .bmad-core/tasks/create-doc.md ====================
==================== START: .bmad-core/tasks/execute-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Checklist Validation Task
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
@@ -282,6 +284,7 @@ The LLM will:
==================== END: .bmad-core/tasks/execute-checklist.md ====================
==================== START: .bmad-core/tasks/generate-ai-frontend-prompt.md ====================
<!-- Powered by BMAD™ Core -->
# Create AI Frontend Prompt Task
## Purpose
@@ -336,6 +339,7 @@ You will now synthesize the inputs and the above principles into a final, compre
==================== END: .bmad-core/tasks/generate-ai-frontend-prompt.md ====================
==================== START: .bmad-core/templates/front-end-spec-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: frontend-spec-template-v2
name: UI/UX Specification
@@ -688,6 +692,7 @@ sections:
==================== END: .bmad-core/templates/front-end-spec-tmpl.yaml ====================
==================== START: .bmad-core/data/technical-preferences.md ====================
<!-- Powered by BMAD™ Core -->
# User-Defined Preferred Patterns and Preferences
None Listed

View File

@@ -95,6 +95,7 @@ dependencies:
==================== END: .bmad-2d-phaser-game-dev/agents/game-designer.md ====================
==================== START: .bmad-2d-phaser-game-dev/tasks/create-doc.md ====================
<!-- Powered by BMAD™ Core -->
# Create Document from Template (YAML Driven)
## ⚠️ CRITICAL EXECUTION NOTICE ⚠️
@@ -199,6 +200,7 @@ User can type `#yolo` to toggle to YOLO mode (process all sections at once).
==================== END: .bmad-2d-phaser-game-dev/tasks/create-doc.md ====================
==================== START: .bmad-2d-phaser-game-dev/tasks/execute-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Checklist Validation Task
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
@@ -288,6 +290,7 @@ The LLM will:
==================== END: .bmad-2d-phaser-game-dev/tasks/execute-checklist.md ====================
==================== START: .bmad-2d-phaser-game-dev/tasks/game-design-brainstorming.md ====================
<!-- Powered by BMAD™ Core -->
# Game Design Brainstorming Techniques Task
This task provides a comprehensive toolkit of creative brainstorming techniques specifically designed for game design ideation and innovative thinking. The game designer can use these techniques to facilitate productive brainstorming sessions focused on game mechanics, player experience, and creative concepts.
@@ -581,6 +584,7 @@ This task provides a comprehensive toolkit of creative brainstorming techniques
==================== END: .bmad-2d-phaser-game-dev/tasks/game-design-brainstorming.md ====================
==================== START: .bmad-2d-phaser-game-dev/tasks/create-deep-research-prompt.md ====================
<!-- Powered by BMAD™ Core -->
# Create Deep Research Prompt Task
This task helps create comprehensive research prompts for various types of deep analysis. It can process inputs from brainstorming sessions, project briefs, market research, or specific research questions to generate targeted prompts for deeper investigation.
@@ -862,6 +866,7 @@ CRITICAL: collaborate with the user to develop specific, actionable research que
==================== END: .bmad-2d-phaser-game-dev/tasks/create-deep-research-prompt.md ====================
==================== START: .bmad-2d-phaser-game-dev/tasks/advanced-elicitation.md ====================
<!-- Powered by BMAD™ Core -->
# Advanced Game Design Elicitation Task
## Purpose
@@ -975,6 +980,7 @@ The questions and perspectives offered should always consider:
==================== END: .bmad-2d-phaser-game-dev/tasks/advanced-elicitation.md ====================
==================== START: .bmad-2d-phaser-game-dev/templates/game-design-doc-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: game-design-doc-template-v2
name: Game Design Document (GDD)
@@ -1321,6 +1327,7 @@ sections:
==================== END: .bmad-2d-phaser-game-dev/templates/game-design-doc-tmpl.yaml ====================
==================== START: .bmad-2d-phaser-game-dev/templates/level-design-doc-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: level-design-doc-template-v2
name: Level Design Document
@@ -1808,6 +1815,7 @@ sections:
==================== END: .bmad-2d-phaser-game-dev/templates/level-design-doc-tmpl.yaml ====================
==================== START: .bmad-2d-phaser-game-dev/templates/game-brief-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: game-brief-template-v2
name: Game Brief
@@ -2167,6 +2175,7 @@ sections:
==================== END: .bmad-2d-phaser-game-dev/templates/game-brief-tmpl.yaml ====================
==================== START: .bmad-2d-phaser-game-dev/checklists/game-design-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Game Design Document Quality Checklist
## Document Completeness

View File

@@ -102,6 +102,7 @@ dependencies:
==================== END: .bmad-2d-phaser-game-dev/agents/game-developer.md ====================
==================== START: .bmad-2d-phaser-game-dev/tasks/execute-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Checklist Validation Task
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
@@ -191,6 +192,7 @@ The LLM will:
==================== END: .bmad-2d-phaser-game-dev/tasks/execute-checklist.md ====================
==================== START: .bmad-2d-phaser-game-dev/templates/game-architecture-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: game-architecture-template-v2
name: Game Architecture Document
@@ -807,6 +809,7 @@ sections:
==================== END: .bmad-2d-phaser-game-dev/templates/game-architecture-tmpl.yaml ====================
==================== START: .bmad-2d-phaser-game-dev/checklists/game-story-dod-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Game Development Story Definition of Done Checklist
## Story Completeness
@@ -970,6 +973,7 @@ _Any specific concerns, recommendations, or clarifications needed before develop
==================== END: .bmad-2d-phaser-game-dev/checklists/game-story-dod-checklist.md ====================
==================== START: .bmad-2d-phaser-game-dev/data/development-guidelines.md ====================
<!-- Powered by BMAD™ Core -->
# Game Development Guidelines
## Overview

View File

@@ -88,6 +88,7 @@ dependencies:
==================== END: .bmad-2d-phaser-game-dev/agents/game-sm.md ====================
==================== START: .bmad-2d-phaser-game-dev/tasks/create-game-story.md ====================
<!-- Powered by BMAD™ Core -->
# Create Game Development Story Task
## Purpose
@@ -307,6 +308,7 @@ This task ensures game development stories are immediately actionable and enable
==================== END: .bmad-2d-phaser-game-dev/tasks/create-game-story.md ====================
==================== START: .bmad-2d-phaser-game-dev/tasks/execute-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Checklist Validation Task
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
@@ -396,6 +398,7 @@ The LLM will:
==================== END: .bmad-2d-phaser-game-dev/tasks/execute-checklist.md ====================
==================== START: .bmad-2d-phaser-game-dev/templates/game-story-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: game-story-template-v2
name: Game Development Story
@@ -652,6 +655,7 @@ sections:
==================== END: .bmad-2d-phaser-game-dev/templates/game-story-tmpl.yaml ====================
==================== START: .bmad-2d-phaser-game-dev/checklists/game-story-dod-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Game Development Story Definition of Done Checklist
## Story Completeness

View File

@@ -40,6 +40,7 @@ These references map directly to bundle sections:
==================== START: .bmad-2d-phaser-game-dev/agent-teams/phaser-2d-nodejs-game-team.yaml ====================
# <!-- Powered by BMAD™ Core -->
bundle:
name: Phaser 2D NodeJS Game Team
icon: 🎮
@@ -162,13 +163,8 @@ commands:
doc-out: Output full document
kb-mode: Load full BMad knowledge base
party-mode: Group chat with all agents
plan: Create detailed workflow plan before starting
plan-status: Show current workflow plan progress
plan-update: Update workflow plan status
status: Show current context, active agent, and progress
task: Run a specific task (list if name not specified)
workflow: Start a specific workflow (list if name not specified)
workflow-guidance: Get personalized help selecting the right workflow
yolo: Toggle skip confirmations mode
exit: Return to BMad or exit session
help-display-template: |
@@ -417,6 +413,7 @@ dependencies:
==================== END: .bmad-2d-phaser-game-dev/agents/game-sm.md ====================
==================== START: .bmad-2d-phaser-game-dev/data/bmad-kb.md ====================
<!-- Powered by BMAD™ Core -->
# Game Development BMad Knowledge Base
## Overview
@@ -670,6 +667,7 @@ This knowledge base provides the foundation for effective game development using
==================== END: .bmad-2d-phaser-game-dev/data/bmad-kb.md ====================
==================== START: .bmad-2d-phaser-game-dev/data/brainstorming-techniques.md ====================
<!-- Powered by BMAD™ Core -->
# Brainstorming Techniques Data
## Creative Expansion
@@ -709,6 +707,7 @@ This knowledge base provides the foundation for effective game development using
==================== END: .bmad-2d-phaser-game-dev/data/brainstorming-techniques.md ====================
==================== START: .bmad-2d-phaser-game-dev/tasks/advanced-elicitation.md ====================
<!-- Powered by BMAD™ Core -->
# Advanced Game Design Elicitation Task
## Purpose
@@ -822,6 +821,7 @@ The questions and perspectives offered should always consider:
==================== END: .bmad-2d-phaser-game-dev/tasks/advanced-elicitation.md ====================
==================== START: .bmad-2d-phaser-game-dev/tasks/create-deep-research-prompt.md ====================
<!-- Powered by BMAD™ Core -->
# Create Deep Research Prompt Task
This task helps create comprehensive research prompts for various types of deep analysis. It can process inputs from brainstorming sessions, project briefs, market research, or specific research questions to generate targeted prompts for deeper investigation.
@@ -1103,6 +1103,7 @@ CRITICAL: collaborate with the user to develop specific, actionable research que
==================== END: .bmad-2d-phaser-game-dev/tasks/create-deep-research-prompt.md ====================
==================== START: .bmad-2d-phaser-game-dev/tasks/create-doc.md ====================
<!-- Powered by BMAD™ Core -->
# Create Document from Template (YAML Driven)
## ⚠️ CRITICAL EXECUTION NOTICE ⚠️
@@ -1207,6 +1208,7 @@ User can type `#yolo` to toggle to YOLO mode (process all sections at once).
==================== END: .bmad-2d-phaser-game-dev/tasks/create-doc.md ====================
==================== START: .bmad-2d-phaser-game-dev/tasks/document-project.md ====================
<!-- Powered by BMAD™ Core -->
# Document an Existing Project
## Purpose
@@ -1553,6 +1555,7 @@ Apply the advanced elicitation task after major sections to refine based on user
==================== END: .bmad-2d-phaser-game-dev/tasks/document-project.md ====================
==================== START: .bmad-2d-phaser-game-dev/tasks/facilitate-brainstorming-session.md ====================
<!-- Powered by BMAD™ Core -->
---
docOutputLocation: docs/brainstorming-session-results.md
template: '.bmad-2d-phaser-game-dev/templates/brainstorming-output-tmpl.yaml'
@@ -1847,10 +1850,11 @@ sections:
content: |
---
*Session facilitated using the BMAD-METHOD brainstorming framework*
*Session facilitated using the BMAD-METHOD brainstorming framework*
==================== END: .bmad-2d-phaser-game-dev/templates/brainstorming-output-tmpl.yaml ====================
==================== START: .bmad-2d-phaser-game-dev/templates/competitor-analysis-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: competitor-analysis-template-v2
name: Competitive Analysis Report
@@ -2160,6 +2164,7 @@ sections:
==================== END: .bmad-2d-phaser-game-dev/templates/competitor-analysis-tmpl.yaml ====================
==================== START: .bmad-2d-phaser-game-dev/templates/market-research-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: market-research-template-v2
name: Market Research Report
@@ -2415,6 +2420,7 @@ sections:
==================== END: .bmad-2d-phaser-game-dev/templates/market-research-tmpl.yaml ====================
==================== START: .bmad-2d-phaser-game-dev/templates/project-brief-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: project-brief-template-v2
name: Project Brief
@@ -2639,6 +2645,7 @@ sections:
==================== END: .bmad-2d-phaser-game-dev/templates/project-brief-tmpl.yaml ====================
==================== START: .bmad-2d-phaser-game-dev/data/elicitation-methods.md ====================
<!-- Powered by BMAD™ Core -->
# Elicitation Methods Data
## Core Reflective Methods
@@ -2796,6 +2803,7 @@ sections:
==================== END: .bmad-2d-phaser-game-dev/data/elicitation-methods.md ====================
==================== START: .bmad-2d-phaser-game-dev/tasks/kb-mode-interaction.md ====================
<!-- Powered by BMAD™ Core -->
# KB Mode Interaction Task
## Purpose
@@ -2874,6 +2882,7 @@ Or ask me about anything else related to BMad-Method!
==================== END: .bmad-2d-phaser-game-dev/tasks/kb-mode-interaction.md ====================
==================== START: .bmad-2d-phaser-game-dev/utils/workflow-management.md ====================
<!-- Powered by BMAD™ Core -->
# Workflow Management
Enables BMad orchestrator to manage and execute team workflows.
@@ -2946,6 +2955,7 @@ Agents should be workflow-aware: know active workflow, their role, access artifa
==================== END: .bmad-2d-phaser-game-dev/utils/workflow-management.md ====================
==================== START: .bmad-2d-phaser-game-dev/tasks/execute-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Checklist Validation Task
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
@@ -3035,6 +3045,7 @@ The LLM will:
==================== END: .bmad-2d-phaser-game-dev/tasks/execute-checklist.md ====================
==================== START: .bmad-2d-phaser-game-dev/tasks/game-design-brainstorming.md ====================
<!-- Powered by BMAD™ Core -->
# Game Design Brainstorming Techniques Task
This task provides a comprehensive toolkit of creative brainstorming techniques specifically designed for game design ideation and innovative thinking. The game designer can use these techniques to facilitate productive brainstorming sessions focused on game mechanics, player experience, and creative concepts.
@@ -3328,6 +3339,7 @@ This task provides a comprehensive toolkit of creative brainstorming techniques
==================== END: .bmad-2d-phaser-game-dev/tasks/game-design-brainstorming.md ====================
==================== START: .bmad-2d-phaser-game-dev/templates/game-design-doc-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: game-design-doc-template-v2
name: Game Design Document (GDD)
@@ -3674,6 +3686,7 @@ sections:
==================== END: .bmad-2d-phaser-game-dev/templates/game-design-doc-tmpl.yaml ====================
==================== START: .bmad-2d-phaser-game-dev/templates/level-design-doc-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: level-design-doc-template-v2
name: Level Design Document
@@ -4161,6 +4174,7 @@ sections:
==================== END: .bmad-2d-phaser-game-dev/templates/level-design-doc-tmpl.yaml ====================
==================== START: .bmad-2d-phaser-game-dev/templates/game-brief-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: game-brief-template-v2
name: Game Brief
@@ -4520,6 +4534,7 @@ sections:
==================== END: .bmad-2d-phaser-game-dev/templates/game-brief-tmpl.yaml ====================
==================== START: .bmad-2d-phaser-game-dev/checklists/game-design-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Game Design Document Quality Checklist
## Document Completeness
@@ -4724,6 +4739,7 @@ _Outline immediate next actions for the team based on this assessment._
==================== END: .bmad-2d-phaser-game-dev/checklists/game-design-checklist.md ====================
==================== START: .bmad-2d-phaser-game-dev/templates/game-architecture-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: game-architecture-template-v2
name: Game Architecture Document
@@ -5340,6 +5356,7 @@ sections:
==================== END: .bmad-2d-phaser-game-dev/templates/game-architecture-tmpl.yaml ====================
==================== START: .bmad-2d-phaser-game-dev/checklists/game-story-dod-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Game Development Story Definition of Done Checklist
## Story Completeness
@@ -5503,6 +5520,7 @@ _Any specific concerns, recommendations, or clarifications needed before develop
==================== END: .bmad-2d-phaser-game-dev/checklists/game-story-dod-checklist.md ====================
==================== START: .bmad-2d-phaser-game-dev/data/development-guidelines.md ====================
<!-- Powered by BMAD™ Core -->
# Game Development Guidelines
## Overview
@@ -6153,6 +6171,7 @@ These guidelines ensure consistent, high-quality game development that meets per
==================== END: .bmad-2d-phaser-game-dev/data/development-guidelines.md ====================
==================== START: .bmad-2d-phaser-game-dev/tasks/create-game-story.md ====================
<!-- Powered by BMAD™ Core -->
# Create Game Development Story Task
## Purpose
@@ -6372,6 +6391,7 @@ This task ensures game development stories are immediately actionable and enable
==================== END: .bmad-2d-phaser-game-dev/tasks/create-game-story.md ====================
==================== START: .bmad-2d-phaser-game-dev/templates/game-story-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: game-story-template-v2
name: Game Development Story
@@ -6628,6 +6648,7 @@ sections:
==================== END: .bmad-2d-phaser-game-dev/templates/game-story-tmpl.yaml ====================
==================== START: .bmad-2d-phaser-game-dev/templates/game-architecture-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: game-architecture-template-v2
name: Game Architecture Document
@@ -7244,6 +7265,7 @@ sections:
==================== END: .bmad-2d-phaser-game-dev/templates/game-architecture-tmpl.yaml ====================
==================== START: .bmad-2d-phaser-game-dev/templates/game-brief-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: game-brief-template-v2
name: Game Brief
@@ -7603,6 +7625,7 @@ sections:
==================== END: .bmad-2d-phaser-game-dev/templates/game-brief-tmpl.yaml ====================
==================== START: .bmad-2d-phaser-game-dev/templates/game-design-doc-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: game-design-doc-template-v2
name: Game Design Document (GDD)
@@ -7949,6 +7972,7 @@ sections:
==================== END: .bmad-2d-phaser-game-dev/templates/game-design-doc-tmpl.yaml ====================
==================== START: .bmad-2d-phaser-game-dev/templates/game-story-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: game-story-template-v2
name: Game Development Story
@@ -8205,6 +8229,7 @@ sections:
==================== END: .bmad-2d-phaser-game-dev/templates/game-story-tmpl.yaml ====================
==================== START: .bmad-2d-phaser-game-dev/templates/level-design-doc-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: level-design-doc-template-v2
name: Level Design Document
@@ -8692,6 +8717,7 @@ sections:
==================== END: .bmad-2d-phaser-game-dev/templates/level-design-doc-tmpl.yaml ====================
==================== START: .bmad-2d-phaser-game-dev/tasks/advanced-elicitation.md ====================
<!-- Powered by BMAD™ Core -->
# Advanced Game Design Elicitation Task
## Purpose
@@ -8805,6 +8831,7 @@ The questions and perspectives offered should always consider:
==================== END: .bmad-2d-phaser-game-dev/tasks/advanced-elicitation.md ====================
==================== START: .bmad-2d-phaser-game-dev/tasks/create-game-story.md ====================
<!-- Powered by BMAD™ Core -->
# Create Game Development Story Task
## Purpose
@@ -9024,6 +9051,7 @@ This task ensures game development stories are immediately actionable and enable
==================== END: .bmad-2d-phaser-game-dev/tasks/create-game-story.md ====================
==================== START: .bmad-2d-phaser-game-dev/tasks/game-design-brainstorming.md ====================
<!-- Powered by BMAD™ Core -->
# Game Design Brainstorming Techniques Task
This task provides a comprehensive toolkit of creative brainstorming techniques specifically designed for game design ideation and innovative thinking. The game designer can use these techniques to facilitate productive brainstorming sessions focused on game mechanics, player experience, and creative concepts.
@@ -9317,6 +9345,7 @@ This task provides a comprehensive toolkit of creative brainstorming techniques
==================== END: .bmad-2d-phaser-game-dev/tasks/game-design-brainstorming.md ====================
==================== START: .bmad-2d-phaser-game-dev/checklists/game-design-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Game Design Document Quality Checklist
## Document Completeness
@@ -9521,6 +9550,7 @@ _Outline immediate next actions for the team based on this assessment._
==================== END: .bmad-2d-phaser-game-dev/checklists/game-design-checklist.md ====================
==================== START: .bmad-2d-phaser-game-dev/checklists/game-story-dod-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Game Development Story Definition of Done Checklist
## Story Completeness
@@ -9684,6 +9714,7 @@ _Any specific concerns, recommendations, or clarifications needed before develop
==================== END: .bmad-2d-phaser-game-dev/checklists/game-story-dod-checklist.md ====================
==================== START: .bmad-2d-phaser-game-dev/workflows/game-dev-greenfield.yaml ====================
# <!-- Powered by BMAD™ Core -->
workflow:
id: game-dev-greenfield
name: Game Development - Greenfield Project
@@ -9870,6 +9901,7 @@ workflow:
==================== END: .bmad-2d-phaser-game-dev/workflows/game-dev-greenfield.yaml ====================
==================== START: .bmad-2d-phaser-game-dev/workflows/game-prototype.yaml ====================
# <!-- Powered by BMAD™ Core -->
workflow:
id: game-prototype
name: Game Prototype Development
@@ -10048,6 +10080,7 @@ workflow:
==================== END: .bmad-2d-phaser-game-dev/workflows/game-prototype.yaml ====================
==================== START: .bmad-2d-phaser-game-dev/data/bmad-kb.md ====================
<!-- Powered by BMAD™ Core -->
# Game Development BMad Knowledge Base
## Overview
@@ -10301,6 +10334,7 @@ This knowledge base provides the foundation for effective game development using
==================== END: .bmad-2d-phaser-game-dev/data/bmad-kb.md ====================
==================== START: .bmad-2d-phaser-game-dev/data/development-guidelines.md ====================
<!-- Powered by BMAD™ Core -->
# Game Development Guidelines
## Overview

View File

@@ -103,6 +103,7 @@ dependencies:
==================== END: .bmad-2d-unity-game-dev/agents/game-architect.md ====================
==================== START: .bmad-2d-unity-game-dev/tasks/create-doc.md ====================
<!-- Powered by BMAD™ Core -->
# Create Document from Template (YAML Driven)
## ⚠️ CRITICAL EXECUTION NOTICE ⚠️
@@ -207,6 +208,7 @@ User can type `#yolo` to toggle to YOLO mode (process all sections at once).
==================== END: .bmad-2d-unity-game-dev/tasks/create-doc.md ====================
==================== START: .bmad-2d-unity-game-dev/tasks/create-deep-research-prompt.md ====================
<!-- Powered by BMAD™ Core -->
# Create Deep Research Prompt Task
This task helps create comprehensive research prompts for various types of deep analysis. It can process inputs from brainstorming sessions, project briefs, market research, or specific research questions to generate targeted prompts for deeper investigation.
@@ -488,6 +490,7 @@ CRITICAL: collaborate with the user to develop specific, actionable research que
==================== END: .bmad-2d-unity-game-dev/tasks/create-deep-research-prompt.md ====================
==================== START: .bmad-2d-unity-game-dev/tasks/shard-doc.md ====================
<!-- Powered by BMAD™ Core -->
# Document Sharding Task
## Purpose
@@ -676,6 +679,7 @@ Document sharded successfully:
==================== END: .bmad-2d-unity-game-dev/tasks/shard-doc.md ====================
==================== START: .bmad-2d-unity-game-dev/tasks/document-project.md ====================
<!-- Powered by BMAD™ Core -->
# Document an Existing Project
## Purpose
@@ -1022,6 +1026,7 @@ Apply the advanced elicitation task after major sections to refine based on user
==================== END: .bmad-2d-unity-game-dev/tasks/document-project.md ====================
==================== START: .bmad-2d-unity-game-dev/tasks/execute-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Checklist Validation Task
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
@@ -1111,6 +1116,7 @@ The LLM will:
==================== END: .bmad-2d-unity-game-dev/tasks/execute-checklist.md ====================
==================== START: .bmad-2d-unity-game-dev/tasks/advanced-elicitation.md ====================
<!-- Powered by BMAD™ Core -->
# Advanced Game Design Elicitation Task
## Purpose
@@ -1224,6 +1230,7 @@ The questions and perspectives offered should always consider:
==================== END: .bmad-2d-unity-game-dev/tasks/advanced-elicitation.md ====================
==================== START: .bmad-2d-unity-game-dev/templates/game-architecture-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: game-architecture-template-v3
name: Game Architecture Document
@@ -2257,6 +2264,7 @@ sections:
==================== END: .bmad-2d-unity-game-dev/templates/game-architecture-tmpl.yaml ====================
==================== START: .bmad-2d-unity-game-dev/checklists/game-architect-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Game Architect Solution Validation Checklist
This checklist serves as a comprehensive framework for the Game Architect to validate the technical design and architecture before game development execution. The Game Architect should systematically work through each item, ensuring the game architecture is robust, scalable, performant, and aligned with the Game Design Document requirements.
@@ -2651,6 +2659,7 @@ After presenting the report, ask the user if they would like detailed analysis o
==================== END: .bmad-2d-unity-game-dev/checklists/game-architect-checklist.md ====================
==================== START: .bmad-2d-unity-game-dev/data/development-guidelines.md ====================
<!-- Powered by BMAD™ Core -->
# Game Development Guidelines (Unity & C#)
## Overview
@@ -3240,6 +3249,7 @@ These guidelines ensure consistent, high-quality game development that meets per
==================== END: .bmad-2d-unity-game-dev/data/development-guidelines.md ====================
==================== START: .bmad-2d-unity-game-dev/data/bmad-kb.md ====================
<!-- Powered by BMAD™ Core -->
# BMad Knowledge Base - 2D Unity Game Development
## Overview

View File

@@ -100,6 +100,7 @@ dependencies:
==================== END: .bmad-2d-unity-game-dev/agents/game-designer.md ====================
==================== START: .bmad-2d-unity-game-dev/tasks/create-doc.md ====================
<!-- Powered by BMAD™ Core -->
# Create Document from Template (YAML Driven)
## ⚠️ CRITICAL EXECUTION NOTICE ⚠️
@@ -204,6 +205,7 @@ User can type `#yolo` to toggle to YOLO mode (process all sections at once).
==================== END: .bmad-2d-unity-game-dev/tasks/create-doc.md ====================
==================== START: .bmad-2d-unity-game-dev/tasks/execute-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Checklist Validation Task
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
@@ -293,6 +295,7 @@ The LLM will:
==================== END: .bmad-2d-unity-game-dev/tasks/execute-checklist.md ====================
==================== START: .bmad-2d-unity-game-dev/tasks/shard-doc.md ====================
<!-- Powered by BMAD™ Core -->
# Document Sharding Task
## Purpose
@@ -481,6 +484,7 @@ Document sharded successfully:
==================== END: .bmad-2d-unity-game-dev/tasks/shard-doc.md ====================
==================== START: .bmad-2d-unity-game-dev/tasks/game-design-brainstorming.md ====================
<!-- Powered by BMAD™ Core -->
# Game Design Brainstorming Techniques Task
This task provides a comprehensive toolkit of creative brainstorming techniques specifically designed for game design ideation and innovative thinking. The game designer can use these techniques to facilitate productive brainstorming sessions focused on game mechanics, player experience, and creative concepts.
@@ -774,6 +778,7 @@ This task provides a comprehensive toolkit of creative brainstorming techniques
==================== END: .bmad-2d-unity-game-dev/tasks/game-design-brainstorming.md ====================
==================== START: .bmad-2d-unity-game-dev/tasks/create-deep-research-prompt.md ====================
<!-- Powered by BMAD™ Core -->
# Create Deep Research Prompt Task
This task helps create comprehensive research prompts for various types of deep analysis. It can process inputs from brainstorming sessions, project briefs, market research, or specific research questions to generate targeted prompts for deeper investigation.
@@ -1055,6 +1060,7 @@ CRITICAL: collaborate with the user to develop specific, actionable research que
==================== END: .bmad-2d-unity-game-dev/tasks/create-deep-research-prompt.md ====================
==================== START: .bmad-2d-unity-game-dev/tasks/advanced-elicitation.md ====================
<!-- Powered by BMAD™ Core -->
# Advanced Game Design Elicitation Task
## Purpose
@@ -1168,6 +1174,7 @@ The questions and perspectives offered should always consider:
==================== END: .bmad-2d-unity-game-dev/tasks/advanced-elicitation.md ====================
==================== START: .bmad-2d-unity-game-dev/templates/game-design-doc-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: game-design-doc-template-v3
name: Game Design Document (GDD)
@@ -1876,6 +1883,7 @@ sections:
==================== END: .bmad-2d-unity-game-dev/templates/game-design-doc-tmpl.yaml ====================
==================== START: .bmad-2d-unity-game-dev/templates/level-design-doc-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: level-design-doc-template-v2
name: Level Design Document
@@ -2363,6 +2371,7 @@ sections:
==================== END: .bmad-2d-unity-game-dev/templates/level-design-doc-tmpl.yaml ====================
==================== START: .bmad-2d-unity-game-dev/templates/game-brief-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: game-brief-template-v3
name: Game Brief
@@ -2722,6 +2731,7 @@ sections:
==================== END: .bmad-2d-unity-game-dev/templates/game-brief-tmpl.yaml ====================
==================== START: .bmad-2d-unity-game-dev/checklists/game-design-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Game Design Document Quality Checklist
## Document Completeness
@@ -2926,6 +2936,7 @@ _Outline immediate next actions for the team based on this assessment._
==================== END: .bmad-2d-unity-game-dev/checklists/game-design-checklist.md ====================
==================== START: .bmad-2d-unity-game-dev/data/bmad-kb.md ====================
<!-- Powered by BMAD™ Core -->
# BMad Knowledge Base - 2D Unity Game Development
## Overview

View File

@@ -97,6 +97,7 @@ dependencies:
==================== END: .bmad-2d-unity-game-dev/agents/game-developer.md ====================
==================== START: .bmad-2d-unity-game-dev/tasks/execute-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Checklist Validation Task
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
@@ -186,6 +187,7 @@ The LLM will:
==================== END: .bmad-2d-unity-game-dev/tasks/execute-checklist.md ====================
==================== START: .bmad-2d-unity-game-dev/tasks/validate-next-story.md ====================
<!-- Powered by BMAD™ Core -->
# Validate Next Story Task
## Purpose
@@ -323,6 +325,7 @@ Provide a structured validation report including:
==================== END: .bmad-2d-unity-game-dev/tasks/validate-next-story.md ====================
==================== START: .bmad-2d-unity-game-dev/checklists/game-story-dod-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Game Development Story Definition of Done (DoD) Checklist
## Instructions for Developer Agent

View File

@@ -88,6 +88,7 @@ dependencies:
==================== END: .bmad-2d-unity-game-dev/agents/game-sm.md ====================
==================== START: .bmad-2d-unity-game-dev/tasks/create-game-story.md ====================
<!-- Powered by BMAD™ Core -->
# Create Game Story Task
## Purpose
@@ -275,6 +276,7 @@ This task ensures game development stories are immediately actionable and enable
==================== END: .bmad-2d-unity-game-dev/tasks/create-game-story.md ====================
==================== START: .bmad-2d-unity-game-dev/tasks/execute-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Checklist Validation Task
This task provides instructions for validating documentation against checklists. The agent MUST follow these instructions to ensure thorough and systematic validation of documents.
@@ -364,6 +366,7 @@ The LLM will:
==================== END: .bmad-2d-unity-game-dev/tasks/execute-checklist.md ====================
==================== START: .bmad-2d-unity-game-dev/tasks/correct-course-game.md ====================
<!-- Powered by BMAD™ Core -->
# Correct Course Task - Game Development
## Purpose
@@ -508,6 +511,7 @@ Based on the analysis and agreed path forward:
==================== END: .bmad-2d-unity-game-dev/tasks/correct-course-game.md ====================
==================== START: .bmad-2d-unity-game-dev/templates/game-story-tmpl.yaml ====================
# <!-- Powered by BMAD™ Core -->
template:
id: game-story-template-v3
name: Game Development Story
@@ -767,6 +771,7 @@ sections:
==================== END: .bmad-2d-unity-game-dev/templates/game-story-tmpl.yaml ====================
==================== START: .bmad-2d-unity-game-dev/checklists/game-change-checklist.md ====================
<!-- Powered by BMAD™ Core -->
# Game Development Change Navigation Checklist
**Purpose:** To systematically guide the Game SM agent and user through analysis and planning when a significant change (performance issue, platform constraint, technical blocker, gameplay feedback) is identified during Unity game development.

Some files were not shown because too many files have changed in this diff Show More