Bmad Walkthrough

by bmad-code-orgbda3c5929f67No license53K starsListed Oct 8, 2026Updated Oct 8, 2026Repository updated yesterday

Guide a human review of a commit, PR, file, or directory. Use when invoked by name

Instructions onlySoftware Development
AI-generated overview

Guides a human review of a commit, PR, file, or directory through a rendered walkthrough workflow.

What it does
This skill runs a renderer script once to produce a workflow document, then reads and follows that rendered workflow. The workflow is organized into steps covering orientation, narrative, and walkthrough, with a log template. It produces a guided human review of a commit, pull request, file, or directory.
When to use it
Use it when invoked by name to walk a human through reviewing a commit, PR, file, or directory. It is intended for review sessions where a structured, guided walkthrough is wanted.
Requirements
Requires the uv runtime and the BMad setup, including a render_skill.py script under the project's _bmad/scripts directory. If the script is missing, the bmad skill's setup must be run first, which may involve installing bmad via npx. The skill ships no scripts itself; it is instructions only.

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:

bash
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 follow and an absolute path to a rendered workflow.md. Read that file and follow it.
  • If the script is not found, BMad is not set up here. Offer to run the bmad skill's setup, installing bmad first 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 uv being unavailable), report the command output and HALT. Do not run any workflow source directly.

Source and attribution

Source:bmad-code-org/bmad-methodinskills/bmad-walkthroughat commitbda3c59

License: No license

Content belongs to its original authors. SourceWeft indexes it from a public repository.

Report or request removal