diff --git a/.github/workflows/bundle-latest.yaml b/.github/workflows/bundle-latest.yaml deleted file mode 100644 index 7c49cb24..00000000 --- a/.github/workflows/bundle-latest.yaml +++ /dev/null @@ -1,330 +0,0 @@ -name: Publish Latest Bundles - -on: - push: - branches: [main] - workflow_dispatch: {} - -permissions: - contents: write - -jobs: - bundle-and-publish: - if: ${{ false }} # Temporarily disabled while web bundles are paused. - runs-on: ubuntu-latest - steps: - - name: Checkout BMAD-METHOD - uses: actions/checkout@v4 - with: - fetch-depth: 0 - - - name: Setup Node.js - uses: actions/setup-node@v4 - with: - node-version-file: ".nvmrc" - cache: npm - - - name: Install dependencies - run: npm ci - - - name: Generate bundles - run: npm run bundle - - - name: Create bundle distribution structure - run: | - mkdir -p dist/bundles - - # Copy web bundles (XML files from npm run bundle output) - cp -r web-bundles/* dist/bundles/ 2>/dev/null || true - - # Verify bundles were copied (fail if completely empty) - if [ ! "$(ls -A dist/bundles)" ]; then - echo "❌ ERROR: No bundles found in dist/bundles/" - echo "This likely means 'npm run bundle' failed or bundles weren't generated" - exit 1 - fi - - # Count bundles per module - for module in bmm bmb cis bmgd; do - if [ -d "dist/bundles/$module/agents" ]; then - COUNT=$(find dist/bundles/$module/agents -name '*.xml' 2>/dev/null | wc -l) - echo "✅ $module: $COUNT agent bundles" - fi - done - - # Generate index.html for each agents directory (fixes directory browsing) - for module in bmm bmb cis bmgd; do - if [ -d "dist/bundles/$module/agents" ]; then - cat > "dist/bundles/$module/agents/index.html" << 'DIREOF' - - -
-Last Updated: $TIMESTAMP
Commit: $COMMIT_SHA
Download all agents for a module as a zip archive:
-Copy the raw XML URL and paste into your AI platform's custom instructions or project knowledge.
-Example: https://raw.githubusercontent.com/bmad-code-org/bmad-bundles/main/bmm/agents/pm.xml
For full IDE integration with slash commands, use the installer:
-npx bmad-method@alpha install- - - - - EOF - - - name: Checkout bmad-bundles repo - uses: actions/checkout@v4 - with: - repository: bmad-code-org/bmad-bundles - path: bmad-bundles - token: ${{ secrets.BUNDLES_PAT }} - - - name: Update bundles - run: | - # Clear old bundles - rm -rf bmad-bundles/* - - # Copy new bundles - cp -r dist/bundles/* bmad-bundles/ - - # Create .nojekyll for GitHub Pages - touch bmad-bundles/.nojekyll - - # Create README - cat > bmad-bundles/README.md << 'EOF' - # BMAD Web Bundles (Latest) - - **⚠️ Unstable Build**: These bundles are auto-generated from the latest `main` branch. - - For stable releases, visit [GitHub Releases](https://github.com/bmad-code-org/BMAD-METHOD/releases/latest). - - ## Usage - - Copy raw markdown URLs for use in AI platforms: - - - Claude Code: `https://raw.githubusercontent.com/bmad-code-org/bmad-bundles/main/claude-code/sub-agents/{agent}.md` - - ChatGPT: `https://raw.githubusercontent.com/bmad-code-org/bmad-bundles/main/chatgpt/sub-agents/{agent}.md` - - Gemini: `https://raw.githubusercontent.com/bmad-code-org/bmad-bundles/main/gemini/sub-agents/{agent}.md` - - ## Browse - - Visit [https://bmad-code-org.github.io/bmad-bundles/](https://bmad-code-org.github.io/bmad-bundles/) to browse bundles. - - ## Installation (Recommended) - - For full IDE integration: - ```bash - npx bmad-method@alpha install - ``` - - --- - - Auto-updated by [BMAD-METHOD](https://github.com/bmad-code-org/BMAD-METHOD) on every main branch merge. - EOF - - - name: Commit and push to bmad-bundles - run: | - cd bmad-bundles - git config user.name "github-actions[bot]" - git config user.email "github-actions[bot]@users.noreply.github.com" - - git add . - - if git diff --staged --quiet; then - echo "No changes to bundles, skipping commit" - else - COMMIT_SHA=$(cd .. && git rev-parse --short HEAD) - git commit -m "Update bundles from BMAD-METHOD@${COMMIT_SHA}" - git push - echo "✅ Bundles published to GitHub Pages" - fi - - - name: Summary - run: | - echo "## 🎉 Bundles Published!" >> $GITHUB_STEP_SUMMARY - echo "" >> $GITHUB_STEP_SUMMARY - echo "**Latest bundles** available at:" >> $GITHUB_STEP_SUMMARY - echo "- 🌐 Browse: https://bmad-code-org.github.io/bmad-bundles/" >> $GITHUB_STEP_SUMMARY - echo "- 📦 Raw files: https://github.com/bmad-code-org/bmad-bundles" >> $GITHUB_STEP_SUMMARY - echo "" >> $GITHUB_STEP_SUMMARY - echo "**Commit**: ${{ github.sha }}" >> $GITHUB_STEP_SUMMARY diff --git a/README.md b/README.md index 0c78e8d4..ea5a8aeb 100644 --- a/README.md +++ b/README.md @@ -11,31 +11,38 @@ ## Why BMad? -Traditional AI tools do the thinking for you, producing average results. BMad agents act as expert collaborators who guide you through structured workflows to bring out your best thinking. +Traditional AI tools do the thinking for you, producing average results. BMad agents and facilitated workflow act as expert collaborators who guide you through a structured process to bring out your best thinking in partnership with the AI. -- **Scale-Adaptive**: Automatically adjusts planning depth based on project complexity (Level 0-4) +- **AI Intelligent Help**: Brand new for beta - AI assisted help will guide you from the beginning to the end - just ask for `/bmad-help` after you have installed BMad to your project +- **Scale-Domain-Adaptive**: Automatically adjusts planning depth and needs based on project complexity, domain and type - a SaaS Mobile Dating App has different planning needs from a diagnostic medical system, BMad adapts and helps you along the way - **Structured Workflows**: Grounded in agile best practices across analysis, planning, architecture, and implementation - **Specialized Agents**: 12+ domain experts (PM, Architect, Developer, UX, Scrum Master, and more) -- **Party Mode**: Bring multiple agent personas into one session to plan, troubleshoot, or discuss your project collaboratively -- **Complete Lifecycle**: From brainstorming to deployment, with just-in-time documentation +- **Party Mode**: Bring multiple agent personas into one session to plan, troubleshoot, or discuss your project collaboratively, multiple perspectives with maximum fun +- **Complete Lifecycle**: From brainstorming to deployment, BMad is there with you every step of the way ## Quick Start **Prerequisites**: [Node.js](https://nodejs.org) v20+ ```bash -npx bmad-method@alpha install +npx bmad-method install ``` Follow the installer prompts, then open your AI IDE (Claude Code, Cursor, Windsurf, etc.) in the project folder. -> **Not sure what to do?** Run `/bmad-help` — it tells you exactly what's next and what's optional. You can also ask it questions like `/bmad-help How should I build a web app for XYZ?` +> **Not sure what to do?** Run `/bmad-help` — it tells you exactly what's next and what's optional. You can also ask it questions like: + + - `/bmad-help How should I build a web app for for my TShirt Business that can scale to millions?` + - `/bmad-help I just finished the architecture, I am not sure what to do next` + +And the amazing this is BMad Help evolves depending on what modules you install also! + - `/bmad-help Im interested in really exploring creative ways to demo BMad at work, what do you recommend to help plan a great slide deck and compelling narrative?`, and if you have the Creative Intelligence Suite installed, it will offer you different or complimentary advice than if you just have BMad Method Module installed! The workflows below show the fastest path to working code. You can also load agents directly for a more structured process, extensive planning, or to learn about agile development practices — the agents guide you with menus, explanations, and elicitation at each step. ### Simple Path (Quick Flow) -Bug fixes, small features, clear scope — 3 commands: +Bug fixes, small features, clear scope — 3 commands - 1 Optional Agent: 1. `/quick-spec` — analyzes your codebase and produces a tech-spec with stories 2. `/dev-story` — implements each story @@ -56,7 +63,7 @@ Every step tells you what's next. Optional phases (brainstorming, research, UX d ## Modules -BMad Method extends with official modules for specialized domains. Modules are available during installation and can be added to your project at any time. +BMad Method extends with official modules for specialized domains. Modules are available during installation and can be added to your project at any time. After the V6 beta period these will also be available as Plugins and Granular Skills. | Module | GitHub | NPM | Purpose | | ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | @@ -65,6 +72,8 @@ BMad Method extends with official modules for specialized domains. Modules are a | **Game Dev Studio (BMGD)** | [bmad-code-org/bmad-module-game-dev-studio](https://github.com/bmad-code-org/bmad-module-game-dev-studio) | [bmad-game-dev-studio](https://www.npmjs.com/package/bmad-game-dev-studio) | Game development workflows for Unity, Unreal, and Godot | | **Creative Intelligence Suite (CIS)** | [bmad-code-org/bmad-module-creative-intelligence-suite](https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite) | [bmad-creative-intelligence-suite](https://www.npmjs.com/package/bmad-creative-intelligence-suite) | Innovation, brainstorming, design thinking, and problem-solving | +* More modules are coming in the next 2 weeks from BMad Official, and a community marketplace for the installer also will be coming with the final V6 release! + ## Documentation **[Full Documentation](http://docs.bmad-method.org)** — Tutorials, how-to guides, concepts, and reference @@ -79,7 +88,7 @@ BMad Method extends with official modules for specialized domains. Modules are a ## Community - [Discord](https://discord.gg/gk8jAdXWmj) — Get help, share ideas, collaborate -- [YouTube](https://www.youtube.com/@BMadCode) — Tutorials, master class, and podcast (launching Feb 2025) +- [Subscribe on YouTube](https://www.youtube.com/@BMadCode) — Tutorials, master class, and podcast (launching Feb 2025) - [GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) — Bug reports and feature requests - [Discussions](https://github.com/bmad-code-org/BMAD-METHOD/discussions) — Community conversations @@ -87,11 +96,10 @@ BMad Method extends with official modules for specialized domains. Modules are a BMad is free for everyone — and always will be. If you'd like to support development: -- ⭐ [Star us on GitHub](https://github.com/bmad-code-org/BMAD-METHOD/) — Helps others discover BMad -- 📺 [Subscribe on YouTube](https://www.youtube.com/@BMadCode) — Master class launching Feb 2026 +- ⭐ Please click the star project icon at near the top right of this page - ☕ [Buy Me a Coffee](https://buymeacoffee.com/bmad) — Fuel the development - 🏢 Corporate sponsorship — DM on Discord -- 🎤 Speaking & Media — Available for conferences, podcasts, interviews (Discord) +- 🎤 Speaking & Media — Available for conferences, podcasts, interviews (BM on Discord) ## Contributing diff --git a/docs/downloads.md b/docs/downloads.md index 7f9a4133..d063c8e1 100644 --- a/docs/downloads.md +++ b/docs/downloads.md @@ -8,19 +8,19 @@ Download BMad Method resources for offline use, AI training, or integration. Download these from the `downloads/` folder on the documentation site. -| File | Description | -|------|-------------| -| `bmad-sources.zip` | Complete BMad source files | +| File | Description | +| ------------------ | ------------------------------- | +| `bmad-sources.zip` | Complete BMad source files | | `bmad-prompts.zip` | Agent and workflow prompts only | ## LLM-Optimized Files These files are designed for AI consumption - perfect for loading into Claude, ChatGPT, or any LLM context window. See [API Access](#api-access) below for URLs. -| File | Description | Use Case | -|------|-------------|----------| -| `llms.txt` | Documentation index with summaries | Quick overview, navigation | -| `llms-full.txt` | Complete documentation concatenated | Full context loading | +| File | Description | Use Case | +| --------------- | ----------------------------------- | -------------------------- | +| `llms.txt` | Documentation index with summaries | Quick overview, navigation | +| `llms-full.txt` | Complete documentation concatenated | Full context loading | ### Using with LLMs @@ -44,7 +44,7 @@ docs = requests.get("https://bmad-code-org.github.io/BMAD-METHOD/llms-full.txt") ## Installation Options ```bash -npx bmad-method@alpha install +npx bmad-method install ``` [More details](/docs/how-to/install-bmad.md) diff --git a/docs/how-to/install-bmad.md b/docs/how-to/install-bmad.md index 126f029f..27e7b253 100644 --- a/docs/how-to/install-bmad.md +++ b/docs/how-to/install-bmad.md @@ -22,7 +22,7 @@ Use the `npx bmad-method install` command to set up BMad in your project with yo ### 1. Run the Installer ```bash -npx bmad-method@alpha install +npx bmad-method install ``` ### 2. Choose Installation Location @@ -68,13 +68,6 @@ your-project/ Run the `help` workflow (`/bmad-help` on most platforms) to verify everything works and see what to do next. -## Living on the Edge - -**Latest pre-release (alpha/beta):** -```bash -npx bmad-method@alpha install -``` - **Latest from main branch:** ```bash npx github:bmad-code-org/BMAD-METHOD install diff --git a/docs/reference/workflow-map.md b/docs/reference/workflow-map.md index 15fc19f0..bde04a51 100644 --- a/docs/reference/workflow-map.md +++ b/docs/reference/workflow-map.md @@ -11,7 +11,9 @@ If at anytime you are unsure what to do, the `/bmad-help` command will help you Final important note: Every workflow below can be run directly with your tool of choice via slash command or by loading an agent first and using the entry from the agents menu. - + + +*[Interactive diagram - hover over outputs to see artifact flows]* ## Phase 1: Analysis (Optional) diff --git a/docs/tutorials/getting-started.md b/docs/tutorials/getting-started.md index bd29888d..38d25a2d 100644 --- a/docs/tutorials/getting-started.md +++ b/docs/tutorials/getting-started.md @@ -20,7 +20,7 @@ Build software faster using AI-powered workflows with specialized agents that gu ::: :::tip[Quick Path] -**Install** → `npx bmad-method@alpha install` +**Install** → `npx bmad-method install` **Plan** → PM creates PRD, Architect creates architecture **Build** → SM manages sprints, DEV implements stories **Fresh chats** for each workflow to avoid context issues. @@ -56,7 +56,7 @@ Story counts are guidance, not definitions. Choose your track based on planning Open a terminal in your project directory and run: ```bash -npx bmad-method@alpha install +npx bmad-method install ``` When prompted to select modules, choose **BMad Method**. @@ -130,11 +130,11 @@ Load the **SM agent** and run `sprint-planning`. This creates `sprint-status.yam For each story, repeat this cycle with fresh chats: -| Step | Agent | Workflow | Purpose | -| ---- | ----- | -------------- | ------------------------------------- | -| 1 | SM | `create-story` | Create story file from epic | -| 2 | DEV | `dev-story` | Implement the story | -| 3 | DEV | `code-review` | Quality validation *(recommended)* | +| Step | Agent | Workflow | Purpose | +| ---- | ----- | -------------- | ---------------------------------- | +| 1 | SM | `create-story` | Create story file from epic | +| 2 | DEV | `dev-story` | Implement the story | +| 3 | DEV | `code-review` | Quality validation *(recommended)* | After completing all stories in an epic, load the **SM agent** and run `retrospective`. @@ -162,17 +162,17 @@ your-project/ ## Quick Reference -| Workflow | Agent | Purpose | -| ---------------------------------- | --------- | ------------------------------------ | -| `help` | Any | Get guidance on what to do next | -| `prd` | PM | Create Product Requirements Document | -| `create-architecture` | Architect | Create architecture document | -| `create-epics-and-stories` | PM | Break down PRD into epics | -| `check-implementation-readiness` | Architect | Validate planning cohesion | -| `sprint-planning` | SM | Initialize sprint tracking | -| `create-story` | SM | Create a story file | -| `dev-story` | DEV | Implement a story | -| `code-review` | DEV | Review implemented code | +| Workflow | Agent | Purpose | +| -------------------------------- | --------- | ------------------------------------ | +| `help` | Any | Get guidance on what to do next | +| `prd` | PM | Create Product Requirements Document | +| `create-architecture` | Architect | Create architecture document | +| `create-epics-and-stories` | PM | Break down PRD into epics | +| `check-implementation-readiness` | Architect | Validate planning cohesion | +| `sprint-planning` | SM | Initialize sprint tracking | +| `create-story` | SM | Create a story file | +| `dev-story` | DEV | Implement a story | +| `code-review` | DEV | Review implemented code | ## Common Questions diff --git a/docs/reference/workflow-map-diagram.html b/website/public/workflow-map-diagram.html similarity index 66% rename from docs/reference/workflow-map-diagram.html rename to website/public/workflow-map-diagram.html index 9335c953..dbc390d6 100644 --- a/docs/reference/workflow-map-diagram.html +++ b/website/public/workflow-map-diagram.html @@ -7,28 +7,11 @@ @@ -577,7 +579,7 @@
create-prd
Define functional and non-functional requirements
+Define requirements (FRs/NFRs)
create-ux-design
If Yes
Design user experience when UX matters
+Design user experience
create-architecture
Make technical decisions explicit with ADRs
+Make technical decisions explicit
create-epics-and-stories
Break requirements into implementable work
+Break into implementable work
check-implementation-readiness
Gate check before implementation begins
+Gate check before implementation
@@ -774,13 +768,19 @@sprint-planning
Initialize tracking (once per project)
+Initialize tracking
create-story
Prepare next story for implementation
+Prepare story for implementation
dev-story
Implement the story with code and tests
+Implement the story
code-review
Validate implementation quality
+Validate implementation
correct-course
Ad-Hoc
Handle significant mid-sprint changes
+Handle mid-sprint changes
retrospective
Per Epic
Review lessons learned after epic completion
+Review lessons learned
Parallel track for small, well-understood changes — skip phases 1-3
+For small, well-understood changes — skip phases 1-3
quick-spec
- quick-spec
+ quick-dev
- quick-dev
+ - Each document becomes context for the next phase. The PRD tells the architect what constraints matter. - The architecture tells the dev agent which patterns to follow. Story files give focused, complete context - for implementation. Without this structure, agents make inconsistent decisions. + Each document becomes context for the next phase. PRD → Architecture, Architecture → Dev, Story → Implementation. + Without this structure, agents make inconsistent decisions.
document-project to create project-context.md
- before Phase 4. Run it when structure, architecture, or rules change.
- document-project to create project-context.md before Phase 4.
+ (Mary / Paige)
Additional context loaded per workflow:
+Context loaded per workflow:
create-story → epics, PRD, architecture, UXdev-story → story filecode-review → architecture, story filequick-spec → planning docs (if exist)quick-dev → tech-speccreate-story epics, PRD, arch, UXdev-story story filecode-review arch, storyquick-dev tech-spec