-
-
Notifications
You must be signed in to change notification settings - Fork 50
refactor: move builder output config from install prompts to per-skill customize.toml #93
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -248,7 +248,7 @@ The optimizer runs three tiers of analysis. | |
|
|
||
| ### Report Synthesis | ||
|
|
||
| After all scanners complete, the optimizer synthesizes results into a unified report saved to `{bmad_builder_reports}/{skill-name}/quality-scan/{timestamp}/`. | ||
| After all scanners complete, the optimizer synthesizes results into a unified report saved to `{target-skill-path}/reports/quality-scan/{timestamp}/` — reports always land next to the skill being analyzed. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Unify quality report directory naming with the skill reference docs. This line documents 🤖 Prompt for AI Agents |
||
|
|
||
| In interactive mode, it presents a summary with severity counts and offers next steps: | ||
|
|
||
|
|
@@ -299,7 +299,7 @@ The HTML report includes: | |
| | **What survived** | Content that earns its place: instructions the LLM wouldn't follow correctly without being told | | ||
| | **Verdict** | One-sentence summary of the conversion | | ||
|
|
||
| Reports are saved to `{bmad_builder_reports}/convert-{skill-name}/`. | ||
| Reports are saved to `{target-skill-path}/reports/convert/` — next to the skill being converted. | ||
|
|
||
| ### When to Use Convert vs Build Process | ||
|
|
||
|
|
@@ -331,7 +331,7 @@ A brainstorming session that helps you plan your module from scratch. The builde | |
| | --------------- | ----------------------------------------------- | | ||
| | **Interaction** | Interactive only; no headless mode | | ||
| | **Input** | An idea or rough description | | ||
| | **Output** | Plan document saved to `{bmad_builder_reports}` | | ||
| | **Output** | Plan document saved to `{output_folder}/module-plans/` | | ||
|
|
||
| **What it covers:** | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| # DO NOT EDIT -- overwritten on every update. | ||
| # | ||
| # Workflow customization surface for bmad-agent-builder. | ||
| # | ||
| # Override files (not edited here): | ||
| # {project-root}/_bmad/custom/bmad-agent-builder.toml (team) | ||
| # {project-root}/_bmad/custom/bmad-agent-builder.user.toml (personal) | ||
|
|
||
| [workflow] | ||
|
|
||
| # Where built agent skills land. Override in team/user TOML to redirect. | ||
| builder_output_folder = "{project-root}/skills" |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,10 @@ | ||
| module,skill,display-name,menu-code,description,action,args,phase,preceded-by,followed-by,required,output-location,outputs | ||
| BMad Builder,bmad-bmb-setup,Setup Builder Module,SB,"Install or update BMad Builder module config and help entries.",configure,"{-H: headless mode}|{inline values: skip prompts with provided values}",anytime,,,false,{project-root}/_bmad,config.yaml and config.user.yaml | ||
| BMad Builder,bmad-agent-builder,Build an Agent,BA,"Create, edit, or rebuild an agent skill through conversational discovery.",build-process,"{-H: headless mode}|{description: initial agent concept}|{path: existing agent to edit or rebuild}",anytime,,bmad-agent-builder:quality-analysis,false,bmad_builder_output_folder,agent skill | ||
| BMad Builder,bmad-agent-builder,Analyze an Agent,AA,"Run quality analysis on an existing agent — structure, cohesion, prompt craft, and enhancement opportunities.",quality-analysis,"{-H: headless mode}|{path: agent to analyze}",anytime,bmad-agent-builder:build-process,,false,bmad_builder_reports,quality report | ||
| BMad Builder,bmad-workflow-builder,Build a Workflow,BW,"Create, edit, or rebuild a workflow or utility skill.",build-process,"{-H: headless mode}|{description: initial skill concept}|{path: existing skill to edit or rebuild}",anytime,,bmad-workflow-builder:quality-analysis,false,bmad_builder_output_folder,workflow skill | ||
| BMad Builder,bmad-workflow-builder,Analyze a Workflow,AW,"Run quality analysis on an existing workflow/skill — structure, efficiency, and enhancement opportunities.",quality-analysis,"{-H: headless mode}|{path: skill to analyze}",anytime,bmad-workflow-builder:build-process,,false,bmad_builder_reports,quality report | ||
| BMad Builder,bmad-workflow-builder,Convert a Skill,CW,"Convert any skill to BMad-compliant, outcome-driven equivalent with before/after HTML comparison report.",convert-process,"{--convert: path or URL to source skill}|{-H: headless mode}",anytime,,,false,bmad_builder_reports,converted skill + comparison report | ||
| BMad Builder,bmad-module-builder,Ideate Module,IM,"Brainstorm and plan a BMad module — explore ideas, decide architecture, and produce a build plan.",ideate-module,"{description: initial module idea}",anytime,,bmad-module-builder:create-module,false,bmad_builder_reports,module plan | ||
| BMad Builder,bmad-module-builder,Create Module,CM,"Scaffold module infrastructure into built skills, making them an installable BMad module.",create-module,"{-H: headless mode}|{path: skills folder or single SKILL.md}",anytime,bmad-module-builder:ideate-module,,false,bmad_builder_output_folder,setup skill | ||
| BMad Builder,bmad-module-builder,Validate Module,VM,"Check that a module's structure is complete, accurate, and all capabilities are properly registered.",validate-module,"{-H: headless mode}|{path: module or skill to validate}",anytime,bmad-module-builder:create-module,,false,bmad_builder_reports,validation report | ||
| BMad Builder,bmad-agent-builder,Build an Agent,BA,"Create, edit, or rebuild an agent skill through conversational discovery.",build-process,"{-H: headless mode}|{description: initial agent concept}|{path: existing agent to edit or rebuild}",anytime,,bmad-agent-builder:quality-analysis,false,builder_output_folder,agent skill | ||
| BMad Builder,bmad-agent-builder,Analyze an Agent,AA,"Run quality analysis on an existing agent — structure, cohesion, prompt craft, and enhancement opportunities.",quality-analysis,"{-H: headless mode}|{path: agent to analyze}",anytime,bmad-agent-builder:build-process,,false,,quality report (lands next to analyzed skill) | ||
| BMad Builder,bmad-workflow-builder,Build a Workflow,BW,"Create, edit, or rebuild a workflow or utility skill.",build-process,"{-H: headless mode}|{description: initial skill concept}|{path: existing skill to edit or rebuild}",anytime,,bmad-workflow-builder:quality-analysis,false,builder_output_folder,workflow skill | ||
| BMad Builder,bmad-workflow-builder,Analyze a Workflow,AW,"Run quality analysis on an existing workflow/skill — structure, efficiency, and enhancement opportunities.",quality-analysis,"{-H: headless mode}|{path: skill to analyze}",anytime,bmad-workflow-builder:build-process,,false,,quality report (lands next to analyzed skill) | ||
| BMad Builder,bmad-workflow-builder,Convert a Skill,CW,"Convert any skill to BMad-compliant, outcome-driven equivalent with before/after HTML comparison report.",convert-process,"{--convert: path or URL to source skill}|{-H: headless mode}",anytime,,,false,,converted skill + comparison report (next to source) | ||
| BMad Builder,bmad-module-builder,Ideate Module,IM,"Brainstorm and plan a BMad module — explore ideas, decide architecture, and produce a build plan.",ideate-module,"{description: initial module idea}",anytime,,bmad-module-builder:create-module,false,output_folder,module plan | ||
| BMad Builder,bmad-module-builder,Create Module,CM,"Scaffold module infrastructure into built skills, making them an installable BMad module.",create-module,"{-H: headless mode}|{path: skills folder or single SKILL.md}",anytime,bmad-module-builder:ideate-module,,false,builder_output_folder,setup skill | ||
| BMad Builder,bmad-module-builder,Validate Module,VM,"Check that a module's structure is complete, accurate, and all capabilities are properly registered.",validate-module,"{-H: headless mode}|{path: module or skill to validate}",anytime,bmad-module-builder:create-module,,false,,validation report (lands next to analyzed module) |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,16 +5,9 @@ module_version: 1.0.0 | |
| default_selected: false | ||
| module_greeting: > | ||
| Enjoy making your dream creations with the BMad Builder Module! | ||
| Run this again at any time if you want to reconfigure a setting or have updated the module, (or optionally just update _bmad/config.yaml and config.user.yaml to change existing values) | ||
|
|
||
| For questions, suggestions and support - check us on Discord at https://discord.gg/gk8jAdXWmj | ||
|
|
||
| bmad_builder_output_folder: | ||
| prompt: "Where should your custom output (agent, workflow, module config) be saved?" | ||
| default: "{project-root}/skills" | ||
| result: "{project-root}/{value}" | ||
| Each builder skill carries its own `customize.toml` with sane defaults (built artifacts land in `{project-root}/skills`). Override per-skill in `_bmad/custom/{skill-name}.toml` if you want a different home; reports and analyses always land next to whatever's being analyzed. | ||
|
|
||
|
|
||
| bmad_builder_reports: | ||
| prompt: "Output for Evals, Test, Quality and Planning Reports?" | ||
| default: "{project-root}/skills/reports" | ||
| result: "{project-root}/{value}" | ||
| For questions, suggestions and support - check us on Discord at https://discord.gg/gk8jAdXWmj | ||
|
Comment on lines
+10
to
+13
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Use double-quoted YAML style for The updated greeting remains in folded-scalar form, which conflicts with the repository YAML rule requiring double-quoted strings. Suggested YAML-compliant form-module_greeting: >
- Enjoy making your dream creations with the BMad Builder Module!
-
-
- Each builder skill carries its own `customize.toml` with sane defaults (built artifacts land in `{project-root}/skills`). Override per-skill in `_bmad/custom/{skill-name}.toml` if you want a different home; reports and analyses always land next to whatever's being analyzed.
-
-
- For questions, suggestions and support - check us on Discord at https://discord.gg/gk8jAdXWmj
+module_greeting: "Enjoy making your dream creations with the BMad Builder Module!\n\nEach builder skill carries its own `customize.toml` with sane defaults (built artifacts land in `{project-root}/skills`). Override per-skill in `_bmad/custom/{skill-name}.toml` if you want a different home; reports and analyses always land next to whatever's being analyzed.\n\nFor questions, suggestions and support - check us on Discord at https://discord.gg/gk8jAdXWmj"🤖 Prompt for AI Agents |
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| # DO NOT EDIT -- overwritten on every update. | ||
| # | ||
| # Workflow customization surface for bmad-eval-runner. | ||
| # | ||
| # Override files (not edited here): | ||
| # {project-root}/_bmad/custom/bmad-eval-runner.toml (team) | ||
| # {project-root}/_bmad/custom/bmad-eval-runner.user.toml (personal) | ||
|
|
||
| [workflow] | ||
|
|
||
| # Fallback for --output-dir when no flag is passed and ~/bmad-evals/ is not | ||
| # desired. Eval runs land under {builder_output_folder}/eval-runs/<run-id>/. | ||
| # Override in team/user TOML to redirect, or pass --output-dir per invocation. | ||
| builder_output_folder = "{project-root}/skills" |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| # DO NOT EDIT -- overwritten on every update. | ||
| # | ||
| # Workflow customization surface for bmad-module-builder. | ||
| # | ||
| # Override files (not edited here): | ||
| # {project-root}/_bmad/custom/bmad-module-builder.toml (team) | ||
| # {project-root}/_bmad/custom/bmad-module-builder.user.toml (personal) | ||
|
|
||
| [workflow] | ||
|
|
||
| # Where created modules and their scaffolded skills land. Override in | ||
| # team/user TOML to redirect. Ideate plan documents land under | ||
| # {output_folder}/module-plans/ (the core BMad planning area), not here. | ||
| builder_output_folder = "{project-root}/skills" |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -167,15 +167,18 @@ Iterate until the user confirms everything is correct. | |
|
|
||
| #### Multi-skill modules (setup skill approach) | ||
|
|
||
| Write the confirmed module.yaml and module-help.csv content to temporary files at `{bmad_builder_reports}/{module-code}-temp-module.yaml` and `{bmad_builder_reports}/{module-code}-temp-help.csv`. Run the scaffold script: | ||
| Write the confirmed module.yaml and module-help.csv content to a freshly-created temp directory (e.g. via `mktemp -d`) — these are ephemeral scaffolding inputs, not user-visible artifacts. Bind the path to `{tmp-dir}` and run the scaffold script: | ||
|
|
||
| ```bash | ||
| TMP_DIR=$(mktemp -d) | ||
| # Write {tmp-dir}/{module-code}-temp-module.yaml and {tmp-dir}/{module-code}-temp-help.csv ... | ||
| python3 ./scripts/scaffold-setup-skill.py \ | ||
| --target-dir "{skills-folder}" \ | ||
| --module-code "{code}" \ | ||
| --module-name "{name}" \ | ||
| --module-yaml "{bmad_builder_reports}/{module-code}-temp-module.yaml" \ | ||
| --module-csv "{bmad_builder_reports}/{module-code}-temp-help.csv" | ||
| --module-yaml "$TMP_DIR/{module-code}-temp-module.yaml" \ | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. In this scaffold snippet, the temp file names use Severity: medium Other Locations
🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage. |
||
| --module-csv "$TMP_DIR/{module-code}-temp-help.csv" | ||
| rm -rf "$TMP_DIR" | ||
| ``` | ||
|
|
||
| This creates `{code}-setup/` in the user's skills folder containing: | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This section says the synthesized report is saved under
{target-skill-path}/reports/quality-scan/{timestamp}/, but other updated docs refer to{target-skill-path}/reports/quality-analysis/...; if both directories aren’t intentionally distinct, readers may look in the wrong location.Severity: low
🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.