bmad-walkthrough
bmad-code-org/bmad-method
Guide structured human review of commits, PRs, files, or directories using BMad workflows.
What is bmad-walkthrough?
Generates a rendered workflow guide for reviewing code changes. Invoke by name to walk through a commit, pull request, file, or directory with step-by-step instructions tailored to the BMad methodology.
- Renders a workflow.md file specific to your project and the code under review
- Provides structured guidance for human code review
- Supports reviewing commits, PRs, files, and directories
- Integrates with BMad project setup and scripts
- Requires absolute paths to project root and skill directory
How to install bmad-walkthrough
npx skills add https://github.com/bmad-code-org/bmad-method --skill bmad-walkthrough- BMad project setup with _bmad/scripts/render_skill.py
- uv package manager installed
- Absolute paths to project root and skill directory
How to use bmad-walkthrough
- 1.Run the provided uv command with your project root and skill root paths
- 2.Wait for the script to print 'read and follow' and the path to workflow.md
- 3.Open and read the generated workflow.md file
- 4.Follow the step-by-step instructions in the workflow
Use cases
- Review a pull request with guided steps before merging
- Walk through a recent commit to understand changes
- Examine a specific file or directory with structured feedback
- Conduct team code reviews using standardized BMad workflow
- Validate code changes against project standards
- Code reviewers
- Development teams using BMad methodology
- Project maintainers
- Engineers conducting peer reviews
bmad-walkthrough FAQ
BMad is not set up in your project. Install the bmad skill first (npx skills add bmad-code-org/BMAD-METHOD --skill bmad), run its setup, then retry the command.
Report the command output and halt. Do not run any workflow source directly without successful script execution.
No. Run the command exactly as specified without changing the current working directory.
Step-by-step review guidance tailored to your project and the specific code (commit, PR, file, or directory) under review.
Full instructions (SKILL.md)
Source of truth, from bmad-code-org/bmad-method.
name: bmad-walkthrough description: 'Guide a human review of a commit, PR, file, or directory. Use when invoked by name'
Run the following command exactly once without changing the current working directory. Replace {project-root} with the absolute path to the project root and {skill-root} with the absolute path to this skill's directory:
uv run --no-cache "{project-root}/_bmad/scripts/render_skill.py" --project-root "{project-root}" --skill "{skill-root}"
- On success, the command prints
read and followand an absolute path to a renderedworkflow.md. Read that file and follow it. - If the script is not found, BMad is not set up here. Offer to run the
bmadskill's setup, installingbmadfirst if you do not have it (npx skills add bmad-code-org/BMAD-METHOD --skill bmad), then run the command above once more. - On any other failure (including
uvbeing unavailable), report the command output and HALT. Do not run any workflow source directly.
Related skills
More from bmad-code-org/bmad-method and the wider catalog.
bmod-core-tools
Core metadata module for BMad—set up via the bmad skill, not directly invoked.
bmod-method
Metadata record for BMad Method module—configure via the bmad skill, not directly.
bmad
BMad Method advisor: setup, maintenance, and skill orchestration for your installation.
bmad-advanced-elicitation
Push LLMs to reconsider and refine output using structured critique methods like Socratic questioning and pre-mortem analysis.
typescript-e2e-testing
E2E and integration testing for TypeScript/NestJS with Jest, supertest, Docker, and Given-When-Then pattern.
biome
Biome - Fast all-in-one toolchain for web projects (linter + formatter in Rust, 100x faster than ESLint)