Module Setup

Standalone module self-registration. This file is loaded when:

The user passes setup, configure, or install as an argument
The module is not yet registered in {project-root}/_bmad/config.yaml
The skill's first-run init flow detects this is a fresh installation (e.g., agent memory doesn't exist yet)

Overview

Registers this standalone module into a project. Module identity (name, code, version) comes from ./assets/module.yaml (sibling to this file). 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 marked user_setting: true in ./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.

Check Existing Config

Read ./assets/module.yaml for module metadata and variable definitions (the code field is the module identifier)
Check if {project-root}/_bmad/config.yaml exists — if a section matching the module's code is already present, inform the user this is an update (reconfiguration)

If the user provides arguments (e.g. accept all defaults, --headless, or inline values like user name is BMad, I speak Swahili), map any provided values to config keys, use defaults for the rest, and skip interactive prompting. Still display the full confirmation summary at the end.

Collect Configuration

Ask the user for values. Show defaults in brackets. Present all values together so the user can respond once with only the values they want to change (e.g. "change language to Swahili, rest are fine"). Never tell the user to "press enter" or "leave blank" — in a chat interface they must type something to respond.

Default priority (highest wins): existing config values > ./assets/module.yaml defaults.

Core Config

Only collect if no core keys exist yet in config.yaml or config.user.yaml:

user_name (default: BMad) — written exclusively to config.user.yaml
communication_language and document_output_language (default: English — ask as a single language question, both keys get the same answer) — communication_language written exclusively to config.user.yaml
output_folder (default: {project-root}/_bmad-output) — written to config.yaml at root, shared across all modules

Module Config

Read each variable in ./assets/module.yaml that has a prompt field. The module.yaml supports several question types:

Text input: Has prompt, default, and optionally result (template), required, regex, example fields
Single-select: Has a single-select array of value/label options — present as a choice list
Multi-select: Has a multi-select array — present as checkboxes, default is an array
Confirm: default is a boolean — present as Yes/No

Ask using the prompt with its default value. Apply result templates when storing (e.g. {project-root}/{value}). Fields with user_setting: true go exclusively to config.user.yaml.

Write Files

Write a temp JSON file with the collected answers structured as {"core": {...}, "module": {...}} (omit core if it already exists). Then run both scripts — they can run in parallel since they write to different files:

python3 ./scripts/merge-config.py --config-path "{project-root}/_bmad/config.yaml" --user-config-path "{project-root}/_bmad/config.user.yaml" --module-yaml ./assets/module.yaml --answers {temp-file}
python3 ./scripts/merge-help-csv.py --target "{project-root}/_bmad/module-help.csv" --source ./assets/module-help.csv --module-code {module-code}

Both scripts output JSON to stdout with results. If either exits non-zero, surface the error and stop.

Run ./scripts/merge-config.py --help or ./scripts/merge-help-csv.py --help for full usage.

Create Output Directories

After writing config, create any output directories that were configured. For filesystem operations only (such as creating directories), resolve the {project-root} token to the actual project root and create each path-type value from config.yaml that does not yet exist — this includes output_folder and any module variable whose value starts with {project-root}/. The paths stored in the config files must continue to use the literal {project-root} token; only the directories on disk should use the resolved paths. Use mkdir -p or equivalent to create the full path.

If ./assets/module.yaml contains a directories array, also create each listed directory (resolving any {field_name} variables from the collected config values).

Confirm

Use the script JSON output to display what was written — config values set (written to config.yaml at root for core, module section for module values), user settings written to config.user.yaml (user_keys in result), help entries added, fresh install vs update.

If ./assets/module.yaml contains post-install-notes, display them (if conditional, show only the notes matching the user's selected config values).

Then display the module_greeting from ./assets/module.yaml to the user.

Return to Skill

Setup is complete. Resume the main skill's normal activation flow — load config from the freshly written files and proceed with whatever the user originally intended.

6.0 KiB Raw Permalink Blame History