bmad-bmb-setup

Installs and configures the BMad Builder module by writing shared YAML config files.

Updated Mar 1, 2026
One-click install
npx skills add https://github.com/Hexalith/Hexalith.Parties --skill bmad-bmb-setup-hexalith
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bmad-bmb-setup
Source: https://github.com/Hexalith/Hexalith.Parties/tree/main/.agents/skills/bmad-bmb-setup
Command: npx skills add https://github.com/Hexalith/Hexalith.Parties --skill bmad-bmb-setup-hexalith

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires pyyaml, and includes scripts (resource) and assets (resource) components.

What problem does it solve? Setting up a BMad module requires collecting user preferences, merging them into shared configuration files, migrating legacy per-module configs, and cleaning up installer directories — a multi-step process that is error-prone when done manually. ## Core Features & Use Cases - Guided configuration collection: Prompts for core settings (user name, languages, output folder) and module variables defined in assets/module.yaml, with support for headless/argument-driven installs. - Config merging with anti-zombie pattern: Writes core values to _bmad/config.yaml, user-only settings to config.user.yaml, and module help entries to module-help.csv, removing stale entries before writing fresh ones. - Legacy migration and cleanup: Reads old per-module config files as fallback defaults, deletes them after merging, and removes legacy installer directories only after verifying skills exist at the installed location. - Use Case: A developer adds the BMad Builder module to a project and runs the setup to consolidate old installer configs into the new shared config format, then cleans up leftover package directories. ## Quick Start Ask the assistant to install and configure the BMad Builder module in this project, optionally providing values like your user name and preferred language.

Frequently Asked Questions about bmad-bmb-setup

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I install the BMad Builder module in a project?

Run the setup skill, which reads module.yaml for variable definitions, prompts for core and module settings, then runs merge scripts to write _bmad/config.yaml, config.user.yaml, and module-help.csv. You can also pass values inline to skip interactive prompts.

How does BMad module config migration from legacy format work?

The merge-config.py script reads legacy per-module config.yaml files from _bmad/{module-code}/ and _bmad/core/, uses matching values as fallback defaults, writes the new shared config, then deletes the legacy files. Only keys matching the current schema are carried forward.

What is the difference between config.yaml and config.user.yaml in BMad?

config.yaml holds shared project settings like output_folder and document_output_language plus per-module sections. config.user.yaml is intended to be gitignored and exclusively stores user_name, communication_language, and any module variable marked user_setting: true.

Why does the setup script fail with an unresolved {project-root} error?

The scripts reject path arguments containing the literal {project-root} token. That token is only valid inside config values; filesystem path arguments like --config-path and --bmad-dir must be resolved to the actual project root before running.

Is it safe to delete legacy BMad installer directories after setup?

Yes, cleanup-legacy.py verifies that every skill found in the legacy directories exists at .claude/skills/ before removing anything. The script is idempotent, so already-cleaned directories are skipped without error.