mcpField
B
bmad-walkthrough

bmad-walkthrough

github.com/bmad-code-orgTesting & quality54.7k11.8k installsUpdated 1w ago
Repository

About bmad-walkthrough

A BMad skill that renders and runs the workflow for the walkthrough skill. It instructs the agent to execute one specified command, follow the printed workflow, and stop on a halt condition or failure.

Key features

  1. 01Render the skill workflow
  2. 02Run one specified command
  3. 03Follow printed workflow instructions
  4. 04Stop on halt or failure

Use cases

  1. 01Running the walkthrough skill workflow
  2. 02Handling a missing BMad setup
  3. 03Reporting workflow execution failures

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/bmad-code-org/bmad-method --skill bmad-walkthrough

After installing, type/bmad-walkthroughin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

bmod.toml
customize.toml
step-01-orientation.md
step-02-narrative.md
step-03-walkthrough.md
workflow.md
templates/
log-template.md

Details

From the project README

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}"
  • The command prints the skill's workflow: follow it. HALT: <reason>: report the reason and stop.
  • 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.

Comments

Markdown supported