sample-module-setup
Module Setup
Overview
Installs and configures a BMad module into a project. Module identity (name, code, version) comes from ./assets/module.yaml. Collects user preferences and writes them to three files:
{project-root}/_bmad/config.yaml— shared project config: core settings at root (e.g.output_folder,document_output_language) plus a section per module with metadata and module-specific values. User-only keys (user_name,communication_language) are never written here.{project-root}/_bmad/config.user.yaml— personal settings intended to be gitignored:user_name,communication_language, and any module variable markeduser_setting: truein./assets/module.yaml. These values live exclusively here.{project-root}/_bmad/module-help.csv— registers module capabilities for the help system.
Both config scripts use an anti-zombie pattern — existing entries for this module are removed before writing fresh ones, so stale values never persist.
{project-root} is a literal token in config values — never substitute it with an actual path. It signals to the consuming LLM that the value is relative to the project root, not the skill root.
On Activation
- Read
./assets/module.yamlfor module metadata and variable definitions (thecodefield is the module identifier) - Check if
{project-root}/_bmad/config.yamlexists — if a section matching the module's code is already present, inform the user this is an update - Check for per-module configuration at
{project-root}/_bmad/sam/config.yamland{project-root}/_bmad/core/config.yaml. If either file exists:
More from bmad-code-org/bmad-builder
bmad-agent-builder
Builds, edits or analyzes Agent Skills through conversational discovery. Use when the user requests to "Create an Agent", "Analyze an Agent" or "Edit an Agent".
6bmad-workflow-builder
Builds, converts, and analyzes workflows and skills. Use when the user requests to "build a workflow", "modify a workflow", "quality check workflow", "analyze skill", or "convert a skill".
6bmad-bmb-setup
Sets up BMad Builder module in a project. Use when the user requests to 'install bmb module', 'configure BMad Builder', or 'setup BMad Builder'.
3bmad-builder-setup
Sets up BMad Builder module in a project. Use when the user requests to 'install bmb module', 'configure bmad builder', or 'setup bmad builder'.
3bmad-module-builder
Plans, creates, and validates BMad modules. Use when the user requests to 'ideate module', 'plan a module', 'create module', 'build a module', or 'validate module'.
3bmad-excalidraw
Creates Excalidraw diagrams through guided or autonomous workflows. Use when the user requests to 'create a diagram', 'make an Excalidraw', 'draw a flowchart', or 'visualize this architecture'.
2