93 lines
13 KiB
Markdown
93 lines
13 KiB
Markdown
# BMAD Commands
|
|
|
|
> Auto-generated by bmalph. Do not edit.
|
|
|
|
## Agents
|
|
|
|
| Command | Description | Invocation |
|
|
|---------|-------------|------------|
|
|
| analyst | Research, briefs, discovery | Read and follow the agent defined in `_bmad/bmm/agents/analyst.agent.yaml`. |
|
|
| architect | Technical design, architecture | Read and follow the agent defined in `_bmad/bmm/agents/architect.agent.yaml`. |
|
|
| brainstorm-project | brainstorm-project | Adopt the role of the agent defined in `_bmad/bmm/agents/analyst.agent.yaml`, then read and execute the workflow at `_bmad/core/skills/bmad-brainstorming/workflow.md` using `_bmad/bmm/data/project-context-template.md` as context data. |
|
|
| dev | Implementation, coding | Read and follow the agent defined in `_bmad/bmm/agents/dev.agent.yaml`. |
|
|
| pm | PRDs, epics, stories | Read and follow the agent defined in `_bmad/bmm/agents/pm.agent.yaml`. |
|
|
| qa | Test automation, quality assurance | Read and follow the agent defined in `_bmad/bmm/agents/qa.agent.yaml`. |
|
|
| quick-flow-solo-dev | Quick one-off tasks, small changes | Read and follow the agent defined in `_bmad/bmm/agents/quick-flow-solo-dev.agent.yaml`. |
|
|
| sm | Sprint planning, status, coordination | Read and follow the agent defined in `_bmad/bmm/agents/sm.agent.yaml`. |
|
|
| tech-writer | Documentation, technical writing | Read and follow the agent defined in `_bmad/bmm/agents/tech-writer/tech-writer.agent.yaml`. |
|
|
| ux-designer | User experience, wireframes | Read and follow the agent defined in `_bmad/bmm/agents/ux-designer.agent.yaml`. |
|
|
|
|
## Phase 1: Analysis
|
|
|
|
| Command | Description | Invocation |
|
|
|---------|-------------|------------|
|
|
| create-brief | A guided experience to nail down your product idea | Adopt the role of the agent defined in `_bmad/bmm/agents/analyst.agent.yaml`, then read and execute the workflow at `_bmad/bmm/workflows/1-analysis/bmad-create-product-brief/workflow.md` in Create mode. |
|
|
| domain-research | Industry domain deep dive subject matter expertise and terminology | Adopt the role of the agent defined in `_bmad/bmm/agents/analyst.agent.yaml`, then read and execute the workflow at `_bmad/bmm/workflows/1-analysis/research/bmad-domain-research/workflow.md`. |
|
|
| market-research | Market analysis competitive landscape customer needs and trends | Adopt the role of the agent defined in `_bmad/bmm/agents/analyst.agent.yaml`, then read and execute the workflow at `_bmad/bmm/workflows/1-analysis/research/bmad-market-research/workflow.md`. |
|
|
| technical-research | Technical feasibility architecture options and implementation approaches | Adopt the role of the agent defined in `_bmad/bmm/agents/analyst.agent.yaml`, then read and execute the workflow at `_bmad/bmm/workflows/1-analysis/research/bmad-technical-research/workflow.md`. |
|
|
| validate-brief | A guided experience to nail down your product idea | Adopt the role of the agent defined in `_bmad/bmm/agents/analyst.agent.yaml`, then read and execute the workflow at `_bmad/bmm/workflows/1-analysis/bmad-create-product-brief/workflow.md` in Validate mode. |
|
|
|
|
## Phase 2: Planning
|
|
|
|
| Command | Description | Invocation |
|
|
|---------|-------------|------------|
|
|
| create-prd | Expert led facilitation to produce your Product Requirements Document | Adopt the role of the agent defined in `_bmad/bmm/agents/pm.agent.yaml`, then read and execute the workflow at `_bmad/core/tasks/bmad-create-prd/workflow.md`. |
|
|
| create-ux | Guidance through realizing the plan for your UX, strongly recommended if a UI is a primary piece of the proposed project | Adopt the role of the agent defined in `_bmad/bmm/agents/ux-designer.agent.yaml`, then read and execute the workflow at `_bmad/bmm/workflows/2-plan-workflows/bmad-create-ux-design/workflow.md` in Create mode. |
|
|
| edit-prd | Improve and enhance an existing PRD | Adopt the role of the agent defined in `_bmad/bmm/agents/pm.agent.yaml`, then read and execute the workflow at `_bmad/bmm/workflows/2-plan-workflows/bmad-edit-prd/workflow.md`. |
|
|
| validate-prd | Validate PRD is comprehensive lean well organized and cohesive | Adopt the role of the agent defined in `_bmad/bmm/agents/pm.agent.yaml`, then read and execute the workflow at `_bmad/bmm/workflows/2-plan-workflows/bmad-validate-prd/workflow.md`. |
|
|
| validate-ux | Guidance through realizing the plan for your UX, strongly recommended if a UI is a primary piece of the proposed project | Adopt the role of the agent defined in `_bmad/bmm/agents/ux-designer.agent.yaml`, then read and execute the workflow at `_bmad/bmm/workflows/2-plan-workflows/bmad-create-ux-design/workflow.md` in Validate mode. |
|
|
|
|
## Phase 3: Solutioning
|
|
|
|
| Command | Description | Invocation |
|
|
|---------|-------------|------------|
|
|
| create-architecture | Guided Workflow to document technical decisions | Adopt the role of the agent defined in `_bmad/bmm/agents/architect.agent.yaml`, then read and execute the workflow at `_bmad/bmm/workflows/3-solutioning/bmad-create-architecture/workflow.md` in Create mode. |
|
|
| create-epics-stories | Create the Epics and Stories Listing | Adopt the role of the agent defined in `_bmad/bmm/agents/pm.agent.yaml`, then read and execute the workflow at `_bmad/bmm/workflows/3-solutioning/bmad-create-epics-and-stories/workflow.md` in Create mode. |
|
|
| implementation-readiness | Ensure PRD UX Architecture and Epics Stories are aligned | Adopt the role of the agent defined in `_bmad/bmm/agents/architect.agent.yaml`, then read and execute the workflow at `_bmad/bmm/workflows/3-solutioning/bmad-check-implementation-readiness/workflow.md` in Validate mode. |
|
|
| validate-architecture | Guided Workflow to document technical decisions | Adopt the role of the agent defined in `_bmad/bmm/agents/architect.agent.yaml`, then read and execute the workflow at `_bmad/bmm/workflows/3-solutioning/bmad-create-architecture/workflow.md` in Validate mode. |
|
|
| validate-epics-stories | Create the Epics and Stories Listing | Adopt the role of the agent defined in `_bmad/bmm/agents/pm.agent.yaml`, then read and execute the workflow at `_bmad/bmm/workflows/3-solutioning/bmad-create-epics-and-stories/workflow.md` in Validate mode. |
|
|
|
|
## Phase 4: Implementation
|
|
|
|
| Command | Description | Invocation |
|
|
|---------|-------------|------------|
|
|
| create-story | Story cycle start: Prepare first found story in the sprint plan that is next, or if the command is run with a specific epic and story designation with context. Once complete, then VS then DS then CR then back to DS if needed or next CS or ER | Adopt the role of the agent defined in `_bmad/bmm/agents/sm.agent.yaml`, then read and execute the workflow at `_bmad/bmm/workflows/4-implementation/bmad-create-story/workflow.md` in Create mode. |
|
|
| qa-automate | Generate automated API and E2E tests for implemented code using the project's existing test framework (detects existing well known in use test frameworks). Use after implementation to add test coverage. NOT for code review or story validation - use CR for that. | Adopt the role of the agent defined in `_bmad/bmm/agents/qa.agent.yaml`, then read and execute the workflow at `_bmad/bmm/workflows/bmad-qa-generate-e2e-tests/workflow.md`. |
|
|
| retrospective | Optional at epic end: Review completed work lessons learned and next epic or if major issues consider CC | Adopt the role of the agent defined in `_bmad/bmm/agents/sm.agent.yaml`, then read and execute the workflow at `_bmad/bmm/workflows/4-implementation/bmad-retrospective/workflow.md`. |
|
|
| sprint-planning | Generate sprint plan for development tasks - this kicks off the implementation phase by producing a plan the implementation agents will follow in sequence for every story in the plan. | Adopt the role of the agent defined in `_bmad/bmm/agents/sm.agent.yaml`, then read and execute the workflow at `_bmad/bmm/workflows/4-implementation/bmad-sprint-planning/workflow.md` in Create mode. |
|
|
| sprint-status | Anytime: Summarize sprint status and route to next workflow | Adopt the role of the agent defined in `_bmad/bmm/agents/sm.agent.yaml`, then read and execute the workflow at `_bmad/bmm/workflows/4-implementation/bmad-sprint-status/workflow.md`. |
|
|
| validate-story | Story cycle start: Prepare first found story in the sprint plan that is next, or if the command is run with a specific epic and story designation with context. Once complete, then VS then DS then CR then back to DS if needed or next CS or ER | Adopt the role of the agent defined in `_bmad/bmm/agents/sm.agent.yaml`, then read and execute the workflow at `_bmad/bmm/workflows/4-implementation/bmad-create-story/workflow.md` in Validate mode. |
|
|
|
|
## Utilities
|
|
|
|
| Command | Description | Invocation |
|
|
|---------|-------------|------------|
|
|
| advanced-elicitation | advanced elicitation | Read and execute the workflow/task at `_bmad/core/skills/bmad-advanced-elicitation/workflow.md`. |
|
|
| adversarial-review | adversarial review | Read and execute the workflow/task at `_bmad/core/skills/bmad-review-adversarial-general/workflow.md`. |
|
|
| bmad-help | bmad help | Read and execute the workflow/task at `_bmad/core/skills/bmad-help/workflow.md`. |
|
|
| brainstorming | brainstorming | Read and execute the workflow/task at `_bmad/core/skills/bmad-brainstorming/workflow.md`. |
|
|
| correct-course | Anytime: Navigate significant changes. May recommend start over update PRD redo architecture sprint planning or correct epics and stories | Adopt the role of the agent defined in `_bmad/bmm/agents/sm.agent.yaml`, then read and execute the workflow at `_bmad/bmm/workflows/4-implementation/bmad-correct-course/workflow.md` in Create mode. |
|
|
| distillator | distillator | Read and execute the workflow/task at `_bmad/core/skills/bmad-distillator/SKILL.md`. |
|
|
| document-project | Analyze an existing project to produce useful documentation | Adopt the role of the agent defined in `_bmad/bmm/agents/analyst.agent.yaml`, then read and execute the workflow at `_bmad/bmm/workflows/bmad-document-project/workflow.md` in Create mode. |
|
|
| edge-case-hunter | edge case hunter | Read and execute the workflow/task at `_bmad/core/skills/bmad-review-edge-case-hunter/workflow.md`. |
|
|
| editorial-prose | editorial prose | Read and execute the workflow/task at `_bmad/core/skills/bmad-editorial-review-prose/workflow.md`. |
|
|
| editorial-structure | editorial structure | Read and execute the workflow/task at `_bmad/core/skills/bmad-editorial-review-structure/workflow.md`. |
|
|
| generate-project-context | Scan existing codebase to generate a lean LLM-optimized project-context.md containing critical implementation rules patterns and conventions for AI agents. Essential for brownfield projects and quick-flow. | Adopt the role of the agent defined in `_bmad/bmm/agents/analyst.agent.yaml`, then read and execute the workflow at `_bmad/bmm/workflows/bmad-generate-project-context/workflow.md`. |
|
|
| index-docs | index docs | Read and execute the workflow/task at `_bmad/core/skills/bmad-index-docs/workflow.md`. |
|
|
| party-mode | party mode | Read and execute the workflow/task at `_bmad/core/skills/bmad-party-mode/workflow.md`. |
|
|
| quick-dev-new | Unified quick flow (experimental): clarify intent plan implement review and present in a single workflow | Adopt the role of the agent defined in `_bmad/bmm/agents/quick-flow-solo-dev.agent.yaml`, then read and execute the workflow at `_bmad/bmm/workflows/bmad-quick-flow/bmad-quick-dev-new-preview/workflow.md` in Create mode. |
|
|
| quick-dev | Quick one-off tasks small changes simple apps utilities without extensive planning - Do not suggest for potentially very complex things unless requested or if the user complains that they do not want to follow the extensive planning of the bmad method, unless the user is already working through the implementation phase and just requests a 1 off things not already in the plan | Adopt the role of the agent defined in `_bmad/bmm/agents/quick-flow-solo-dev.agent.yaml`, then read and execute the workflow at `_bmad/bmm/workflows/bmad-quick-flow/bmad-quick-dev/workflow.md` in Create mode. |
|
|
| shard-doc | shard doc | Read and execute the workflow/task at `_bmad/core/skills/bmad-shard-doc/workflow.md`. |
|
|
| tech-spec | Do not suggest for potentially very complex things unless requested or if the user complains that they do not want to follow the extensive planning of the bmad method. Quick one-off tasks small changes simple apps brownfield additions to well established patterns utilities without extensive planning | Adopt the role of the agent defined in `_bmad/bmm/agents/quick-flow-solo-dev.agent.yaml`, then read and execute the workflow at `_bmad/bmm/workflows/bmad-quick-flow/bmad-quick-spec/workflow.md` in Create mode. |
|
|
|
|
## bmalph CLI
|
|
|
|
| Command | Description | How to run |
|
|
|---------|-------------|------------|
|
|
| bmalph-doctor | Check project health and report issues | Run `bmalph doctor` |
|
|
| bmalph-implement | Transition planning artifacts to Ralph format | Run `bmalph implement` |
|
|
| bmalph-status | Show current phase, Ralph progress, version info | Run `bmalph status` |
|
|
| bmalph-upgrade | Update bundled assets to current version | Run `bmalph upgrade` |
|
|
| bmalph-watch | Launch Ralph live dashboard | Run `bmalph run` |
|
|
| bmalph | BMAD master agent — navigate phases | Read and follow the master agent instructions in this file |
|