You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Add interactive workflow guide page
Replace confusing static SVG workflow diagram with an interactive
guide at /workflow-guide. Users select their track (Quick Flow,
BMad Method, Enterprise) and see relevant phases, agents, commands,
and outputs. Update link validator to recognize custom page routes.
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
* Add visual dev loop indicator to workflow guide
Wrap create-story, dev-story, and code-review in a dashed border
group with a "Repeat for each story" label to clearly communicate
the iterative development cycle in Phase 4.
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
* Simplify workflow guide to vertical slash command flow
Replace expandable phase cards with a clean vertical flow showing
slash commands as the primary element, with down arrows between
steps, agent badges, required/optional status, and concise
descriptions. Add prominent /bmad-help callout and note that
agent loading is optional.
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
* Simplify README Quick Start with numbered command flows
Replace wordy paragraphs and track table with two clear numbered
paths (Quick Flow: 3 commands, BMad Method: 6 steps) and a
prominent /bmad-help callout as the primary guidance mechanism.
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
* Add Party Mode to README, /bmad-help to getting-started
Add Party Mode bullet to Why BMad section, note about agent-based
usage as an alternative to direct workflows, and a /bmad-help
mention in the getting-started tutorial after installation.
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
* Add link to getting-started tutorial in README Quick Start
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
* Add workflow guide link to docs index New Here section
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
* Update README tagline and format modules table
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
* Fix workflow-guide links to use relative paths
The /workflow-guide absolute path breaks with non-root base paths.
Use relative paths since workflow-guide is a custom Astro page
outside the docs collection. Docs-to-docs links keep the /docs/
pattern which the rehype plugin handles.
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
* Revert workflow-guide links to absolute paths
Use /workflow-guide to match the /docs/ convention used throughout.
Works correctly on the production site where base path is /.
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
**Build More, Architect Dreams** — An AI-driven agile development framework with 21 specialized agents, 50+ guided workflows, and scale-adaptive intelligence that adjusts from bug fixes to enterprise systems.
8
+
**Breakthrough Method of Agile AI Driven Development** — An AI-driven agile development framework with 21 specialized agents, 50+ guided workflows, and scale-adaptive intelligence that adjusts from bug fixes to enterprise systems.
9
9
10
10
**100% free and open source.** No paywalls. No gated content. No gated Discord. We believe in empowering everyone, not just those who can pay.
11
11
@@ -16,6 +16,7 @@ Traditional AI tools do the thinking for you, producing average results. BMad ag
16
16
-**Scale-Adaptive**: Automatically adjusts planning depth based on project complexity (Level 0-4)
17
17
-**Structured Workflows**: Grounded in agile best practices across analysis, planning, architecture, and implementation
-**Party Mode**: Bring multiple agent personas into one session to plan, troubleshoot, or discuss your project collaboratively
19
20
-**Complete Lifecycle**: From brainstorming to deployment, with just-in-time documentation
20
21
21
22
## Quick Start
@@ -26,34 +27,43 @@ Traditional AI tools do the thinking for you, producing average results. BMad ag
26
27
npx bmad-method@alpha install
27
28
```
28
29
29
-
Follow the installer prompts to configure your project.
30
+
Follow the installer prompts, then open your AI IDE (Claude Code, Cursor, Windsurf, etc.) in the project folder.
30
31
31
-
Once you have installed BMad to a folder, launch your tool of choice from where you installed BMad. (We really like Claude Code and Cursor - but there are any that work great with BMad!)
32
+
> **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?`
32
33
33
-
Then its simple as running the command: `/bmad-help` if you do not know what to do. Depending on which modules you have installed, you will have different choices.
34
+
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.
34
35
35
-
To make the help more applicable you can even run the `/bmad-help What do you suggest I do to get started building a brand new web application for XYZ`.
36
+
### Simple Path (Quick Flow)
36
37
37
-
The results from BMad Help will be able to suggest and constantly guide you on what to do next - along with the workflows upon completion also making suggestions on what to do next.
38
+
Bug fixes, small features, clear scope — 3 commands:
38
39
39
-
This analyzes your project and recommends a track:
40
+
1.`/quick-spec` — analyzes your codebase and produces a tech-spec with stories
|**Enterprise**| Compliance-heavy systems |~1-3 hours |
44
+
### Full Planning Path (BMad Method)
45
+
46
+
Products, platforms, complex features — structured planning then build:
47
+
48
+
1.`/product-brief` — define problem, users, and MVP scope
49
+
2.`/create-prd` — full requirements with personas, metrics, and risks
50
+
3.`/create-architecture` — technical decisions and system design
51
+
4.`/create-epics-and-stories` — break work into prioritized stories
52
+
5.`/sprint-planning` — initialize sprint tracking
53
+
6.**Repeat per story:**`/create-story` → `/dev-story` → `/code-review`
54
+
55
+
Every step tells you what's next. Optional phases (brainstorming, research, UX design) are available when you need them — ask `/bmad-help` anytime. For a detailed walkthrough, see the [Getting Started Tutorial](http://docs.bmad-method.org/tutorials/getting-started/getting-started-bmadv6/).
46
56
47
57
## Modules
48
58
49
59
BMad Method extends with official modules for specialized domains. Modules are available during installation and can be added to your project at any time.
50
60
51
-
| Module | GitHub | NPM | Purpose |
52
-
|--------|--------|-----|---------|
53
-
|**BMad Method (BMM)**|[bmad-code-org/BMAD-METHOD](https://github.com/bmad-code-org/BMAD-METHOD)|[bmad-method](https://www.npmjs.com/package/bmad-method)| Core framework with 34+ workflows across 4 development phases |
|**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 |
56
-
|**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 |
|**BMad Method (BMM)**|[bmad-code-org/BMAD-METHOD](https://github.com/bmad-code-org/BMAD-METHOD)|[bmad-method](https://www.npmjs.com/package/bmad-method)| Core framework with 34+ workflows across 4 development phases|
|**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|
66
+
|**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 |
Copy file name to clipboardExpand all lines: docs/index.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,6 +13,7 @@ If you're comfortable working with AI coding assistants like Claude, Cursor, or
13
13
The fastest way to understand BMad is to try it. Choose a tutorial to walk through your first project in about 10 minutes.
14
14
15
15
-**[Get Started with BMad](/docs/tutorials/getting-started/getting-started-bmadv6.md)** — Latest features, still in active development
16
+
-**[Workflow Guide](/workflow-guide)** — A simple visual overview of the various BMad tracks that get you going quickly.
16
17
17
18
:::tip[Already familiar with AI-assisted development?]
18
19
Feel free to skip around. Use the sidebar to jump to any topic, or check out [What Are Agents?](/docs/explanation/core-concepts/what-are-agents.md) to understand how BMad organizes its AI personas.
| 4 | Implementation | Build epic by epic, story by story |
44
44
45
-

46
-
47
-
*Complete visual flowchart showing all phases, workflows, and agents for the standard greenfield track.*
45
+
**[Open the Interactive Workflow Guide](/workflow-guide)** to explore phases, agents, and outputs for your chosen track.
48
46
49
47
Based on your project's complexity, BMad offers three planning tracks:
50
48
@@ -86,6 +84,8 @@ your-project/
86
84
Having issues? See [Install BMad](/docs/how-to/installation/install-bmad.md) for common solutions.
87
85
:::
88
86
87
+
Open your AI IDE in the project folder. From here, you can run `/bmad-help` anytime to see what to do next — or ask it a question like `/bmad-help How should I build a web app for XYZ?`
88
+
89
89
## Step 1: Initialize Your Project
90
90
91
91
Load the **Analyst agent** in your IDE, wait for the menu, then run `workflow-init`.
0 commit comments