refactor(skills): remove bmad-skill-manifest yaml; introduce central config.toml (#2285)
* refactor: remove bmad-skill-manifest yaml; introduce four-layer central config.toml
- Agent essence moves from per-skill bmad-skill-manifest.yaml files
into each module.yaml's `agents:` block (code, name, title, icon,
description). Per-agent customize.toml remains the deep-behavior
source of truth.
- Installer emits four TOML files:
_bmad/config.toml team install answers + agent roster
_bmad/config.user.toml user install answers
_bmad/custom/config.toml team overrides stub
_bmad/custom/config.user.toml personal overrides stub
Prompts declare scope: user to route answers to config.user.toml.
- resolve_config.py merges four layers: base-team -> base-user ->
custom-team -> custom-user.
- Three consumer skills (party-mode, advanced-elicitation,
retrospective) switched from agent-manifest.csv to the resolver.
- installer.js mergeModuleHelpCatalogs now takes the in-memory
agent list from ManifestGenerator -- no CSV roundtrip.
- Deleted: 6 bmad-skill-manifest.yaml files, agent-manifest.csv
emission, collectAgents/getAgentsFromDirRecursive,
paths.agentManifest().
* fix(installer): strip core-key pollution from [modules.*]; soften config headers
- writeCentralConfig now always strips core-module keys from every
[modules.<code>] bucket, even when the module's schema is not
available in src/ (external / marketplace modules like cis, bmb).
Core values belong in [core] only; workflows read them directly.
- When the module's own schema IS available (built-in modules),
also drop any key it does not declare as a prompt — same
spread-pollution filter as before, now layered on top.
- Section-aware headers on both _bmad/config.toml and
_bmad/config.user.toml: [core] / [modules.*] values are
editable (installer reads them as defaults on next install);
[agents.*] is regenerated from module.yaml and will be wiped —
overrides for agents go in _bmad/custom/config*.toml instead.
* docs: cover central config.toml + Diataxis prose pass across three files
Document the new four-file central configuration surface (_bmad/config.toml,
config.user.toml, and custom/ overrides) alongside the existing per-skill
customize.toml. Make editing rules, scope partitioning, and when-to-use-which
guidance explicit.
- customize-bmad.md: new "Central Configuration" section with editing rules,
three worked examples (rebrand, fictional agent, module settings override),
and a "when to use which surface" table. Converted five h4 headers to
bold paragraph intros per style guide.
- expand-bmad-for-your-org.md: two-layer mental model extended to three;
new Recipe 5 with three variants (rebrand, custom crew, pinned team
settings); reinforcement table extended.
- named-agents.md: noted the dual customization surface — per-skill shapes
behavior, central config shapes roster identity.
Diataxis prose pass applied across all three files: banned vocabulary
check, em-dash cap, hypophora / metanoia / amplificatio / stakes-inflation
cleanup, rhythm and burstiness fixes. Structural conformance verified;
markdownlint and prettier clean.
* test+docs: add central config unit tests; fix stale recipe count
- test: two new suites (35 + 36) covering writeCentralConfig and
ensureCustomConfigStubs. Verifies scope partitioning (user_name
lands only in config.user.toml), core-key pollution stripping
from [modules.*], unknown-schema fallthrough (external modules
survive without schema), agent roster baked into config.toml
[agents.*] only, stub-preservation on re-install. 44 new
assertions.
- docs: fixed four stale "four recipes" references to say "five"
after Recipe 5 (Customize the Agent Roster) was added. Touches
frontmatter, opening paragraph, Combining Recipes paragraph,
and the named-agents cross-link blurb.
* fix: address PR review feedback on central config
- resolve_config.py argparse: three-layer → four-layer description
- SKILL/workflow/explanation docs: document all four layers including
_bmad/config.user.toml (was missing from merge-stack descriptions)
- customize-bmad.md + installer headers: drop the false "direct edits to
config.toml persist" claim; installer reads from per-module config.yaml,
not central TOML, so direct edits get clobbered. Route users to
_bmad/custom/config.toml for durable overrides
- writeCentralConfig: warn loudly when a module.yaml can't be parsed
(previously silent — user-scoped keys could mis-file into team config)
- writeCentralConfig: preserve [agents.*] blocks for modules that didn't
contribute fresh agents this run (e.g. quickUpdate skipping modules
whose source is unavailable) so the roster doesn't silently shrink
- add extractAgentBlocks helper + Test Suite 37 covering preservation
Addresses comments from augmentcode and coderabbitai on PR #2285.
This commit is contained in:
Brian
GitHub
parent
0dbfae675b
commit
4405b817a9
|
|
@ -53,11 +53,11 @@ When you invoke a named agent, eight steps run in order:
|
|||
7. **Execute append steps** — any post-greet setup the team configured
|
||||
8. **Dispatch or present the menu** — if your opening message maps to a menu item, go directly; otherwise render the menu and wait for input
|
||||
|
||||
Step 8 is where the magic lands. "Hey Mary, let's brainstorm" skips rendering because `bmad-brainstorming` is an obvious match for `BP` on Mary's menu. If you say something ambiguous, she asks — once, briefly, not as a confirmation ritual. If nothing fits, she continues the conversation normally.
|
||||
Step 8 is where intent meets capability. "Hey Mary, let's brainstorm" skips rendering because `bmad-brainstorming` is an obvious match for `BP` on Mary's menu. If you say something ambiguous, she asks once, briefly, not as a confirmation ritual. If nothing fits, she continues the conversation normally.
|
||||
|
||||
## Why Not Just a Menu?
|
||||
|
||||
Menus force the user to meet the tool halfway. You have to remember that brainstorming lives under code `BP` on the analyst agent, not the PM agent. You have to know which persona owns which capabilities. That's cognitive overhead the tool is making you carry.
|
||||
Menus force the user to meet the tool halfway. You have to remember that brainstorming lives under code `BP` on the analyst agent, not the PM agent, and know which persona owns which capabilities. That's cognitive overhead the tool is making you carry.
|
||||
|
||||
Named agents invert it. You say what you want, to whom, in whatever words feel natural. The agent knows who they are and what they do. When your intent is clear enough, they just go.
|
||||
|
||||
|
|
@ -65,25 +65,27 @@ The menu is still there as a fallback — show it when you're exploring, skip it
|
|||
|
||||
## Why Not Just a Blank Prompt?
|
||||
|
||||
Blank prompts assume you know the magic words. "Help me brainstorm" might work; "let's ideate on my SaaS idea" might not. Results vary based on how you phrase the ask. You become responsible for prompt engineering.
|
||||
Blank prompts assume you know the magic words. "Help me brainstorm" might work, but "let's ideate on my SaaS idea" might not, and the results depend on how you phrased the ask. You become responsible for prompt engineering.
|
||||
|
||||
Named agents bring structure without taking freedom. The persona is consistent, the capabilities are discoverable, the menu is always one `bmad-help` away. You don't have to guess what the agent can do — but you also don't have to consult a manual to do it.
|
||||
Named agents add structure without closing off freedom. The persona stays consistent, the capabilities are discoverable, and `bmad-help` is always one command away. You don't have to guess what the agent can do, and you don't need a manual to use it either.
|
||||
|
||||
## Customization as a First-Class Citizen
|
||||
|
||||
The customization model is why this scales beyond a single developer.
|
||||
The customization model is what lets this scale beyond a single developer.
|
||||
|
||||
Every agent ships a `customize.toml` with sensible defaults. Teams commit overrides to `_bmad/custom/bmad-agent-{role}.toml`. Individuals can layer personal preferences in `.user.toml` (gitignored). The resolver merges all three at activation time with predictable structural rules.
|
||||
|
||||
Concrete example: a team commits a single file telling Amelia to always use the Context7 MCP tool for library docs and to fall back to Linear when a story isn't in the local epics list. Every dev workflow Amelia dispatches — dev-story, quick-dev, create-story, code-review — inherits that behavior. No source edits, no forks, no per-workflow duplication.
|
||||
Concrete example: a team commits a single file telling Amelia to always use the Context7 MCP tool for library docs and to fall back to Linear when a story isn't in the local epics list. Every dev workflow Amelia dispatches (dev-story, quick-dev, create-story, code-review) inherits that behavior, with no source edits or per-workflow duplication required.
|
||||
|
||||
There's also a second customization surface for *cross-cutting* concerns: the central `_bmad/config.toml` and `_bmad/config.user.toml` (both installer-owned, rebuilt from each module's `module.yaml`) plus `_bmad/custom/config.toml` (team, committed) and `_bmad/custom/config.user.toml` (personal, gitignored) for overrides. This is where the **agent roster** lives — the lightweight descriptors that roster consumers like `bmad-party-mode`, `bmad-retrospective`, and `bmad-advanced-elicitation` read to know who's available and how to embody them. Rebrand an agent org-wide with a team override; add fictional voices (Kirk, Spock, a domain expert persona) as personal experiments via the `.user.toml` override — without touching any skill folder. The per-skill file shapes how Mary *behaves* when she activates; the central config shapes how other skills *see* her when they look at the field.
|
||||
|
||||
For the full customization surface and worked examples, see:
|
||||
|
||||
- [How to Customize BMad](../how-to/customize-bmad.md) — the reference for what's customizable and how merge works
|
||||
- [How to Expand BMad for Your Organization](../how-to/expand-bmad-for-your-org.md) — four worked recipes spanning agent-wide rules, workflow conventions, external publishing, and template swaps
|
||||
- [How to Expand BMad for Your Organization](../how-to/expand-bmad-for-your-org.md) — five worked recipes spanning agent-wide rules, workflow conventions, external publishing, template swaps, and agent roster customization
|
||||
|
||||
## The Bigger Idea
|
||||
|
||||
Most AI assistants today are either menus or prompts. Both shift cognitive load onto the user. Named agents plus customizable skills do something different: they let you talk to a teammate who already knows the work, and let your organization shape that teammate without forking.
|
||||
Most AI assistants today are either menus or prompts, and both shift cognitive load onto the user. Named agents plus customizable skills let you talk to a teammate who already knows the work, and let your organization shape that teammate without forking.
|
||||
|
||||
The next time you type "Hey Mary, let's brainstorm" and she just gets on with it — notice what didn't happen. No slash command. No menu navigation. No awkward reminder of what she can do. That absence is the design.
|
||||
The next time you type "Hey Mary, let's brainstorm" and she just gets on with it, notice what didn't happen. There was no slash command, no menu to navigate, no awkward reminder of what she can do. That absence is the design.
|
||||
|
|
|
|||
|
|
@ -49,9 +49,7 @@ The resolver applies four structural rules. Field names are never special-cased
|
|||
|
||||
**No removal mechanism.** Overrides cannot delete base items. If you need to suppress a default menu item, override it by `code` with a no-op description or prompt. If you need to restructure an array more deeply, fork the skill.
|
||||
|
||||
#### The `code` / `id` convention
|
||||
|
||||
BMad uses `code` (short identifier like `"BP"` or `"R1"`) and `id` (longer stable identifier) as merge keys on arrays of tables. If you author a custom array-of-tables that should be replaceable-by-key rather than append-only, pick **one** convention (either `code` on every item, or `id` on every item) and stick with it across the whole array. Mixing `code` on some items and `id` on others falls back to append — the resolver won't guess which key to merge on.
|
||||
**The `code` / `id` convention.** BMad uses `code` (short identifier like `"BP"` or `"R1"`) and `id` (longer stable identifier) as merge keys on arrays of tables. If you author a custom array-of-tables that should be replaceable-by-key rather than append-only, pick **one** convention (either `code` on every item, or `id` on every item) and stick with it across the whole array. Mixing `code` on some items and `id` on others falls back to append — the resolver won't guess which key to merge on.
|
||||
|
||||
### Some agent fields are read-only
|
||||
|
||||
|
|
@ -106,9 +104,7 @@ This appends the new principle to the defaults (leaving the shipped principles i
|
|||
|
||||
All examples below assume BMad's flat agent schema. Fields live directly under `[agent]` — no nested `metadata` or `persona` sub-tables.
|
||||
|
||||
#### Scalars (icon, role, identity, communication_style)
|
||||
|
||||
Scalar overrides simply win. You only need to set the fields you're changing:
|
||||
**Scalars (icon, role, identity, communication_style).** Scalar overrides win. You only need to set the fields you're changing:
|
||||
|
||||
```toml
|
||||
# _bmad/custom/bmad-agent-pm.toml
|
||||
|
|
@ -119,9 +115,7 @@ role = "Drives product discovery for a regulated healthcare domain."
|
|||
communication_style = "Precise, regulatory-aware, asks compliance-shaped questions early."
|
||||
```
|
||||
|
||||
#### Persistent Facts, Principles, Activation Hooks (append arrays)
|
||||
|
||||
All four arrays below are append-only. Team items run after defaults, user items run last.
|
||||
**Persistent facts, principles, activation hooks (append arrays).** All four arrays below are append-only. Team items run after defaults, user items run last.
|
||||
|
||||
```toml
|
||||
[agent]
|
||||
|
|
@ -158,11 +152,9 @@ activation_steps_append = [
|
|||
]
|
||||
```
|
||||
|
||||
**Why two hooks?** Prepend runs before greeting so the agent can load context it needs to personalize the greeting itself. Append runs after greeting so the user isn't staring at a blank terminal while heavy scans complete.
|
||||
**The two hooks do different jobs.** Prepend runs before greeting so the agent can load context it needs to personalize the greeting itself. Append runs after greeting so the user isn't staring at a blank terminal while heavy scans complete.
|
||||
|
||||
#### Menu Customization (merge by `code`)
|
||||
|
||||
The menu is an array of tables. Each item has a `code` field (BMad convention), so the resolver merges by code: matching codes replace in place, new codes append.
|
||||
**Menu customization (merge by `code`).** The menu is an array of tables. Each item has a `code` field (BMad convention), so the resolver merges by code: matching codes replace in place, new codes append.
|
||||
|
||||
TOML array-of-tables syntax uses `[[agent.menu]]` for each item:
|
||||
|
||||
|
|
@ -186,9 +178,7 @@ Report any gaps and cite the relevant regulatory section.
|
|||
|
||||
Each menu item has exactly one of `skill` (invokes a registered skill) or `prompt` (executes the text directly). Items not listed in your override keep their defaults.
|
||||
|
||||
#### Referencing Files
|
||||
|
||||
When a field's text needs to point at a file (in `persistent_facts`, `activation_steps_prepend`/`activation_steps_append`, or a menu item's `prompt`), use a full path rooted at `{project-root}`. Even if the file sits next to your override in `_bmad/custom/`, spell out the full path: `{project-root}/_bmad/custom/info.md`. The agent resolves `{project-root}` at runtime.
|
||||
**Referencing files.** When a field's text needs to point at a file (in `persistent_facts`, `activation_steps_prepend`/`activation_steps_append`, or a menu item's `prompt`), use a full path rooted at `{project-root}`. Even if the file sits next to your override in `_bmad/custom/`, spell out the full path: `{project-root}/_bmad/custom/info.md`. The agent resolves `{project-root}` at runtime.
|
||||
|
||||
### 4. Personal vs Team
|
||||
|
||||
|
|
@ -215,7 +205,7 @@ python3 {project-root}/_bmad/scripts/resolve_customization.py \
|
|||
--key agent
|
||||
```
|
||||
|
||||
**Requirements**: Python 3.11+ (earlier versions don't include `tomllib`). No `pip install`, no `uv`, no virtualenv. Check with `python3 --version` — some common platforms (macOS without Homebrew, Ubuntu 22.04) default `python3` to 3.10 or earlier even when 3.11+ is available to install separately.
|
||||
**Requirements**: Python 3.11+ (earlier versions don't include `tomllib`). No `pip install`, no `uv`, no virtualenv. Check with `python3 --version`. Some platforms (macOS without Homebrew, Ubuntu 22.04) default `python3` to 3.10 or earlier, so you may need to install 3.11+ separately.
|
||||
|
||||
`--skill` points at the skill's installed directory (where `customize.toml` lives). The skill name is derived from the directory's basename, and the script looks up `_bmad/custom/{skill-name}.toml` and `{skill-name}.user.toml` automatically.
|
||||
|
||||
|
|
@ -241,7 +231,7 @@ Output is always JSON. If the script is unavailable on a given platform, the SKI
|
|||
|
||||
## Workflow Customization
|
||||
|
||||
Workflows (skills that drive multi-step processes like `bmad-product-brief`) share the same override mechanism as agents. Their customizable surface lives under `[workflow]` instead of `[agent]`, keeping the two namespaces cleanly separated:
|
||||
Workflows (skills that drive multi-step processes like `bmad-product-brief`) share the same override mechanism as agents. Their customizable surface lives under `[workflow]` instead of `[agent]`:
|
||||
|
||||
```toml
|
||||
# _bmad/custom/bmad-product-brief.toml
|
||||
|
|
@ -266,11 +256,96 @@ persistent_facts = [
|
|||
on_complete = "Summarize the brief in three bullets and offer to email it via the gws-gmail-send skill."
|
||||
```
|
||||
|
||||
The same field conventions cross the agent/workflow boundary: `activation_steps_prepend`/`activation_steps_append`, `persistent_facts` (with `file:` refs), menu-style `[[…]]` tables with `code`/`id` for keyed merge. The resolver applies the same four structural rules regardless of the top-level key. SKILL.md references follow the namespace: `{workflow.activation_steps_prepend}`, `{workflow.persistent_facts}`, `{workflow.on_complete}`. Any additional fields a workflow exposes (output paths, toggles, review settings, stage flags) follow the same merge rules based on their shape. Read the workflow's `customize.toml` to see what it makes customizable.
|
||||
The same field conventions cross the agent/workflow boundary: `activation_steps_prepend`/`activation_steps_append`, `persistent_facts` (with `file:` refs), and menu-style `[[…]]` tables with `code`/`id` for keyed merge. The resolver applies the same four structural rules regardless of the top-level key. SKILL.md references follow the namespace: `{workflow.activation_steps_prepend}`, `{workflow.persistent_facts}`, `{workflow.on_complete}`. Any additional fields a workflow exposes (output paths, toggles, review settings, stage flags) follow the same shape-based merge rules. Read the workflow's `customize.toml` to see what's customizable.
|
||||
|
||||
## Central Configuration
|
||||
|
||||
Per-skill `customize.toml` covers **deep behavior** (hooks, menus, persistent_facts, persona overrides for a single agent or workflow). A separate surface covers **cross-cutting state** — install answers and the agent roster that external skills like `bmad-party-mode`, `bmad-retrospective`, and `bmad-advanced-elicitation` consume. That surface lives in four TOML files at project root:
|
||||
|
||||
```text
|
||||
_bmad/config.toml (installer-owned) team scope: install answers + agent roster
|
||||
_bmad/config.user.toml (installer-owned) user scope: user_name, language, skill level
|
||||
_bmad/custom/config.toml (human-authored) team overrides (committed to git)
|
||||
_bmad/custom/config.user.toml (human-authored) personal overrides (gitignored)
|
||||
```
|
||||
|
||||
### Four-Layer Merge
|
||||
|
||||
```text
|
||||
Priority 1 (wins): _bmad/custom/config.user.toml
|
||||
Priority 2: _bmad/custom/config.toml
|
||||
Priority 3: _bmad/config.user.toml
|
||||
Priority 4 (base): _bmad/config.toml
|
||||
```
|
||||
|
||||
Same structural rules as per-skill customize (scalars override, tables deep-merge, `code`/`id`-keyed arrays merge by key, other arrays append).
|
||||
|
||||
### What Lives Where
|
||||
|
||||
The installer partitions answers by the `scope:` declared on each prompt in `module.yaml`:
|
||||
|
||||
- `[core]` and `[modules.<code>]` sections — install answers. Scope `team` lands in `_bmad/config.toml`; scope `user` lands in `_bmad/config.user.toml`.
|
||||
- `[agents.<code>]` — agent essence (code, name, title, icon, description, team) distilled from each module's `module.yaml` `agents:` block. Always team-scoped.
|
||||
|
||||
### Editing Rules
|
||||
|
||||
- `_bmad/config.toml` and `_bmad/config.user.toml` are **regenerated every install** from the answers collected during the installer flow. Treat them as read-only outputs — direct edits will be overwritten on the next install. To change an install answer durably, re-run the installer (it remembers your prior answers as defaults) or shadow the value in `_bmad/custom/config.toml`.
|
||||
- `_bmad/custom/config.toml` and `_bmad/custom/config.user.toml` are **never touched** by the installer. This is the correct surface for custom agents, agent descriptor overrides, team-enforced settings, and any value you want to pin regardless of install answers.
|
||||
|
||||
### Example — Rebrand an Agent
|
||||
|
||||
```toml
|
||||
# _bmad/custom/config.toml (committed to git, applies to every developer)
|
||||
|
||||
[agents.bmad-agent-pm]
|
||||
description = "Healthcare PM — regulatory-aware, stakeholder-driven, FDA-shaped questions first."
|
||||
icon = "🏥"
|
||||
```
|
||||
|
||||
The resolver merges over the installer-written `[agents.bmad-agent-pm]`. `bmad-party-mode` and any other roster consumer pick up the new description automatically.
|
||||
|
||||
### Example — Add a Fictional Agent
|
||||
|
||||
```toml
|
||||
# _bmad/custom/config.user.toml (personal, gitignored)
|
||||
|
||||
[agents.kirk]
|
||||
team = "startrek"
|
||||
name = "Captain James T. Kirk"
|
||||
title = "Starship Captain"
|
||||
icon = "🖖"
|
||||
description = "Bold, rule-bending commander. Speaks in dramatic pauses. Thinks aloud about the weight of command."
|
||||
```
|
||||
|
||||
No skill folder required — the essence alone is enough for party-mode to spawn Kirk as a voice. Filter by the `team` field to invite just the Enterprise crew to a roundtable.
|
||||
|
||||
### Example — Override Module Install Settings
|
||||
|
||||
```toml
|
||||
# _bmad/custom/config.toml
|
||||
|
||||
[modules.bmm]
|
||||
planning_artifacts = "/shared/org-planning-artifacts"
|
||||
```
|
||||
|
||||
The override wins over whatever each developer answered during their local install. Useful for pinning team conventions.
|
||||
|
||||
### When to Use Which Surface
|
||||
|
||||
| Need | Use |
|
||||
|---|---|
|
||||
| Add MCP tool calls to every dev workflow | Per-skill: `_bmad/custom/bmad-agent-dev.toml` `persistent_facts` |
|
||||
| Add a menu item to an agent | Per-skill: `_bmad/custom/bmad-agent-{role}.toml` `[[agent.menu]]` |
|
||||
| Swap a workflow's output template | Per-skill: `_bmad/custom/{workflow}.toml` scalar override |
|
||||
| Rebrand an agent's public descriptor | **Central**: `_bmad/custom/config.toml` `[agents.<code>]` |
|
||||
| Add a custom or fictional agent to the roster | **Central**: `_bmad/custom/config.*.toml` new `[agents.<code>]` entry |
|
||||
| Pin team-enforced install settings | **Central**: `_bmad/custom/config.toml` `[modules.<code>]` or `[core]` |
|
||||
|
||||
Use both surfaces in the same project as needed.
|
||||
|
||||
## Worked Examples
|
||||
|
||||
For complete, enterprise-oriented recipes — shaping an agent across every workflow it dispatches, enforcing org conventions, publishing outputs to Confluence and Jira, and swapping in your own output templates — see [How to Expand BMad for Your Organization](./expand-bmad-for-your-org.md).
|
||||
For enterprise-oriented recipes (shaping an agent across every workflow it dispatches, enforcing org conventions, publishing outputs to Confluence and Jira, customizing the agent roster, and swapping in your own output templates), see [How to Expand BMad for Your Organization](./expand-bmad-for-your-org.md).
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
|
|
|
|||
|
|
@ -1,11 +1,11 @@
|
|||
---
|
||||
title: 'How to Expand BMad for Your Organization'
|
||||
description: Four customization patterns that reshape BMad without forking — org conventions, agent-wide rules, external publishing, and template swaps
|
||||
description: Five customization patterns that reshape BMad without forking — agent-wide rules, workflow conventions, external publishing, template swaps, and agent roster changes
|
||||
sidebar:
|
||||
order: 9
|
||||
---
|
||||
|
||||
BMad's customization surface is designed so that an organization can reshape behavior without editing installed files or forking skills. This guide walks through four recipes that together cover most enterprise needs.
|
||||
BMad's customization surface lets an organization reshape behavior without editing installed files or forking skills. This guide walks through five recipes that cover most enterprise needs.
|
||||
|
||||
:::note[Prerequisites]
|
||||
|
||||
|
|
@ -14,7 +14,7 @@ BMad's customization surface is designed so that an organization can reshape beh
|
|||
- Python 3.11+ on PATH (for the resolver — stdlib only, no `pip install`)
|
||||
:::
|
||||
|
||||
## The Two-Layer Mental Model
|
||||
## The Three-Layer Mental Model
|
||||
|
||||
Before picking a recipe, know where your override lands:
|
||||
|
||||
|
|
@ -22,14 +22,15 @@ Before picking a recipe, know where your override lands:
|
|||
|---|---|---|
|
||||
| **Agent** (e.g. Amelia, Mary, John) | `[agent]` section of `_bmad/custom/bmad-agent-{role}.toml` | Travels with the persona into **every workflow the agent dispatches** |
|
||||
| **Workflow** (e.g. product-brief, create-prd) | `[workflow]` section of `_bmad/custom/{workflow-name}.toml` | Applies only to that workflow's run |
|
||||
| **Central config** | `[agents.*]`, `[core]`, `[modules.*]` in `_bmad/custom/config.toml` | Agent roster (who's available for party-mode, retrospective, elicitation), install-time settings pinned org-wide |
|
||||
|
||||
Rule of thumb: if the rule should apply everywhere an engineer does dev work, customize the **dev agent**. If it applies only when someone writes a product brief, customize the **product-brief workflow**.
|
||||
Rule of thumb: if the rule should apply everywhere an engineer does dev work, customize the **dev agent**. If it applies only when someone writes a product brief, customize the **product-brief workflow**. If it changes *who's in the room* (rename an agent, add a custom voice, enforce a shared artifact path), edit **central config**.
|
||||
|
||||
## Recipe 1: Shape an Agent Across Every Workflow It Dispatches
|
||||
|
||||
**Use case:** Standardize tool use and external system integrations so every workflow dispatched through an agent inherits the behavior. Highest-leverage pattern.
|
||||
**Use case:** Standardize tool use and external system integrations so every workflow dispatched through an agent inherits the behavior. This is the highest-impact pattern.
|
||||
|
||||
**Example — Amelia (dev agent) always uses Context7 for library docs, and falls back to Linear when a story isn't found in the epics list:**
|
||||
**Example: Amelia (dev agent) always uses Context7 for library docs, and falls back to Linear when a story isn't found in the epics list.**
|
||||
|
||||
```toml
|
||||
# _bmad/custom/bmad-agent-dev.toml
|
||||
|
|
@ -44,17 +45,17 @@ persistent_facts = [
|
|||
]
|
||||
```
|
||||
|
||||
**Why this is powerful:** Two sentences reshape every dev workflow in the org. No per-workflow duplication, no source changes, no forks. Every new engineer who pulls the repo inherits the conventions automatically.
|
||||
**Why this works:** Two sentences reshape every dev workflow in the org, with no per-workflow duplication and no source changes. Every new engineer who pulls the repo inherits the conventions automatically.
|
||||
|
||||
**Team file vs personal file:**
|
||||
- `bmad-agent-dev.toml` — committed to git; applies to the whole team
|
||||
- `bmad-agent-dev.user.toml` — gitignored; personal preferences layered on top
|
||||
- `bmad-agent-dev.toml`: committed to git; applies to the whole team
|
||||
- `bmad-agent-dev.user.toml`: gitignored; personal preferences layered on top
|
||||
|
||||
## Recipe 2: Enforce Organizational Conventions Inside a Specific Workflow
|
||||
|
||||
**Use case:** Shape the *content* of a workflow's output so it meets compliance, audit, or downstream-consumer requirements.
|
||||
|
||||
**Example — every product brief must include compliance fields, and the agent knows about the org's publishing conventions:**
|
||||
**Example: every product brief must include compliance fields, and the agent knows about the org's publishing conventions.**
|
||||
|
||||
```toml
|
||||
# _bmad/custom/bmad-product-brief.toml
|
||||
|
|
@ -68,13 +69,13 @@ persistent_facts = [
|
|||
]
|
||||
```
|
||||
|
||||
**What happens:** The facts load during Step 3 of the workflow's activation. When the agent drafts the brief, it knows about the required fields and the enterprise conventions document. The shipped default (`file:{project-root}/**/project-context.md`) still loads — this is an append.
|
||||
**What happens:** The facts load during Step 3 of the workflow's activation. When the agent drafts the brief, it knows the required fields and the enterprise conventions document. The shipped default (`file:{project-root}/**/project-context.md`) still loads, since this is an append.
|
||||
|
||||
## Recipe 3: Publish Completed Outputs to External Systems
|
||||
|
||||
**Use case:** Once the workflow produces its output, automatically publish to enterprise systems of record (Confluence, Notion, SharePoint) and open follow-up work (Jira, Linear, Asana).
|
||||
|
||||
**Example — briefs auto-publish to Confluence and offer optional Jira epic creation:**
|
||||
**Example: briefs auto-publish to Confluence and offer optional Jira epic creation.**
|
||||
|
||||
```toml
|
||||
# _bmad/custom/bmad-product-brief.toml
|
||||
|
|
@ -107,18 +108,18 @@ and ask the user to publish manually.
|
|||
"""
|
||||
```
|
||||
|
||||
**Why `on_complete` and not `activation_steps_append`:** `on_complete` runs exactly once, at the terminal stage, after the workflow's main output is written. It's the right moment to publish artifacts. `activation_steps_append` runs every activation, before the workflow does its work.
|
||||
**Why `on_complete` and not `activation_steps_append`:** `on_complete` runs exactly once, at the terminal stage, after the workflow's main output is written. That's the right moment to publish artifacts. `activation_steps_append` runs every activation, before the workflow does its work.
|
||||
|
||||
**Tradeoffs:**
|
||||
- **Confluence publication is non-destructive** — always runs on completion
|
||||
- **Jira epic creation is visible to the whole team** and kicks off sprint-planning signals — gate on user confirmation
|
||||
- **Graceful fallback** — if MCP tools fail, hand off to the user rather than silently dropping the output
|
||||
- **Confluence publication is non-destructive** and always runs on completion
|
||||
- **Jira epic creation is visible to the whole team** and kicks off sprint-planning signals, so gate it on user confirmation
|
||||
- **Graceful fallback:** if MCP tools fail, hand off to the user rather than silently dropping the output
|
||||
|
||||
## Recipe 4: Swap in Your Own Output Template
|
||||
|
||||
**Use case:** The default output structure doesn't match your organization's expected format, or different orgs in the same repo need different templates.
|
||||
|
||||
**Example — point the product-brief workflow at an enterprise-owned template:**
|
||||
**Example: point the product-brief workflow at an enterprise-owned template.**
|
||||
|
||||
```toml
|
||||
# _bmad/custom/bmad-product-brief.toml
|
||||
|
|
@ -131,19 +132,79 @@ brief_template = "{project-root}/docs/enterprise/brief-template.md"
|
|||
|
||||
**Template authoring tips:**
|
||||
- Keep templates in `{project-root}/docs/` or `{project-root}/_bmad/custom/templates/` so they version alongside the override file
|
||||
- Use the same structural conventions as the shipped template (section headings, frontmatter) — the agent adapts to what's there
|
||||
- Use the same structural conventions as the shipped template (section headings, frontmatter); the agent adapts to what's there
|
||||
- For multi-org repos, use `.user.toml` to let individual teams point at their own templates without touching the committed team file
|
||||
|
||||
## Recipe 5: Customize the Agent Roster
|
||||
|
||||
**Use case:** Change *who's in the room* for roster-driven skills like `bmad-party-mode`, `bmad-retrospective`, and `bmad-advanced-elicitation`, without editing any source or forking. Three common variants follow.
|
||||
|
||||
### 5a. Rebrand a BMad Agent Org-Wide
|
||||
|
||||
Every real agent has a descriptor the installer synthesizes from `module.yaml`. Override it to shift voice and framing across every roster consumer:
|
||||
|
||||
```toml
|
||||
# _bmad/custom/config.toml (committed — applies to every developer)
|
||||
|
||||
[agents.bmad-agent-analyst]
|
||||
description = "Mary the Regulatory-Aware Business Analyst — channels Porter and Minto, but lives and breathes FDA audit trails. Speaks like a forensic investigator presenting a case file."
|
||||
```
|
||||
|
||||
Party-mode spawns Mary with the new description. The analyst activation itself still runs normally because Mary's behavior lives in her per-skill `customize.toml`. This override changes how **external skills perceive and introduce her**, not how she works internally.
|
||||
|
||||
### 5b. Add a Fictional or Custom Agent
|
||||
|
||||
A full descriptor is enough for roster-based features, with no skill folder needed. Useful for personality variety in party mode or brainstorming sessions:
|
||||
|
||||
```toml
|
||||
# _bmad/custom/config.user.toml (personal — gitignored)
|
||||
|
||||
[agents.spock]
|
||||
team = "startrek"
|
||||
name = "Commander Spock"
|
||||
title = "Science Officer"
|
||||
icon = "🖖"
|
||||
description = "Logic first, emotion suppressed. Begins observations with 'Fascinating.' Never rounds up. Counterpoint to any argument that relies on gut instinct."
|
||||
|
||||
[agents.mccoy]
|
||||
team = "startrek"
|
||||
name = "Dr. Leonard McCoy"
|
||||
title = "Chief Medical Officer"
|
||||
icon = "⚕️"
|
||||
description = "Country doctor's warmth, short fuse. 'Dammit Jim, I'm a doctor not a ___.' Ethics-driven counterweight to Spock."
|
||||
```
|
||||
|
||||
Ask party-mode to "invite the Enterprise crew." It filters by `team = "startrek"` and spawns Spock and McCoy with those descriptors. Real BMad agents (Mary, Amelia) can sit at the same table if you ask them to.
|
||||
|
||||
### 5c. Pin Team Install Settings
|
||||
|
||||
The installer prompts each developer for values like `planning_artifacts` path. When the org needs one shared answer across the team, pin it in central config — any developer's local prompt answer gets overridden at resolution time:
|
||||
|
||||
```toml
|
||||
# _bmad/custom/config.toml
|
||||
|
||||
[modules.bmm]
|
||||
planning_artifacts = "{project-root}/shared/planning"
|
||||
implementation_artifacts = "{project-root}/shared/implementation"
|
||||
|
||||
[core]
|
||||
document_output_language = "English"
|
||||
```
|
||||
|
||||
Personal settings like `user_name`, `communication_language`, or `user_skill_level` stay under each developer's own `_bmad/config.user.toml`. The team file shouldn't touch those.
|
||||
|
||||
**Why central config vs per-agent customize.toml:** Per-agent files shape how *one* agent behaves when it activates. Central config shapes what roster consumers *see when they look at the field:* which agents exist, what they're called, what team they belong to, and the shared install settings the whole repo agrees on. Two surfaces, different jobs.
|
||||
|
||||
## Reinforce Global Rules in Your IDE's Session File
|
||||
|
||||
BMad customizations load when a skill is activated. But many IDE tools also load a global instruction file at the **start of every session**, before any skill runs — `CLAUDE.md`, `AGENTS.md`, `.cursor/rules/`, `.github/copilot-instructions.md`, etc. For rules that should hold even outside BMad skills, restate the critical ones there too.
|
||||
BMad customizations load when a skill is activated. Many IDE tools also load a global instruction file at the **start of every session**, before any skill runs (`CLAUDE.md`, `AGENTS.md`, `.cursor/rules/`, `.github/copilot-instructions.md`, etc). For rules that should hold even outside BMad skills, restate the critical ones there too.
|
||||
|
||||
**When to double up:**
|
||||
- A rule is important enough that a plain chat conversation (no skill active) should still follow it
|
||||
- You want belt-and-suspenders enforcement because training-data defaults might otherwise pull the model off-course
|
||||
- The rule is concise enough to repeat without bloating the session file
|
||||
|
||||
**Example — one line in the repo's `CLAUDE.md` reinforcing the dev-agent rule from Recipe 1:**
|
||||
**Example: one line in the repo's `CLAUDE.md` reinforcing the dev-agent rule from Recipe 1.**
|
||||
|
||||
```markdown
|
||||
<!-- Any file-read of library docs goes through the context7 MCP tool
|
||||
|
|
@ -151,19 +212,20 @@ BMad customizations load when a skill is activated. But many IDE tools also load
|
|||
before relying on training-data knowledge. -->
|
||||
```
|
||||
|
||||
One sentence. Loads every session. Pairs with the `bmad-agent-dev.toml` customization so the rule applies both inside Amelia's workflows and during ad-hoc chats with the assistant. No duplication of effort — each layer owns its scope:
|
||||
One sentence, loaded every session. It pairs with the `bmad-agent-dev.toml` customization so the rule applies both inside Amelia's workflows and during ad-hoc chats with the assistant. Each layer owns its own scope:
|
||||
|
||||
| Layer | Scope | Use for |
|
||||
|---|---|---|
|
||||
| IDE session file (`CLAUDE.md` / `AGENTS.md`) | Every session, before any skill activates | Short, universal rules that should survive outside BMad |
|
||||
| BMad agent customization | Every workflow the agent dispatches | Agent-persona-specific behavior |
|
||||
| BMad workflow customization | One workflow run | Workflow-specific output shape, publishing hooks, templates |
|
||||
| BMad central config | Agent roster + shared install settings | Who's in the room and what shared paths the team uses |
|
||||
|
||||
Keep the IDE file **succinct**. A dozen well-chosen lines are more effective than a sprawling list — models read it every turn, and noise crowds out signal.
|
||||
Keep the IDE file **succinct**. A dozen well-chosen lines are more effective than a sprawling list. Models read it every turn, and noise crowds out signal.
|
||||
|
||||
## Combining Recipes
|
||||
|
||||
All four recipes compose. A realistic enterprise override for `bmad-product-brief` might set `persistent_facts` (Recipe 2), `on_complete` (Recipe 3), and `brief_template` (Recipe 4) in a single file. The agent-level rule (Recipe 1) lives in a separate file under the agent's name and applies in parallel.
|
||||
All five recipes compose. A realistic enterprise override for `bmad-product-brief` might set `persistent_facts` (Recipe 2), `on_complete` (Recipe 3), and `brief_template` (Recipe 4) in one file. The agent-level rule (Recipe 1) lives in a separate file under the agent's name, central config (Recipe 5) pins the shared roster and team settings, and all four apply in parallel.
|
||||
|
||||
```toml
|
||||
# _bmad/custom/bmad-product-brief.toml (workflow-level)
|
||||
|
|
@ -181,12 +243,12 @@ on_complete = """ ... """
|
|||
persistent_facts = ["Always include a 'Regulatory Review' section when the domain involves healthcare, finance, or children's data."]
|
||||
```
|
||||
|
||||
Result: Mary loads the regulatory-review rule at persona activation. When the user picks the product-brief menu item, the workflow loads its own conventions on top, writes to the enterprise template, and publishes to Confluence on completion. Every layer contributes; none of them required editing BMad source.
|
||||
Result: Mary loads the regulatory-review rule at persona activation. When the user picks the product-brief menu item, the workflow loads its own conventions on top, writes to the enterprise template, and publishes to Confluence on completion. Every layer contributes, and none of them required editing BMad source.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**Override not taking effect?** Check that the file is under `_bmad/custom/` with the exact skill directory name (e.g. `bmad-agent-dev.toml`, not `bmad-dev.toml`). See [How to Customize BMad](./customize-bmad.md#troubleshooting).
|
||||
|
||||
**MCP tool name unknown?** Use the exact name the MCP server exposes in the current session. Ask Claude Code to list available MCP tools if unsure — hardcoded names in `persistent_facts` or `on_complete` won't work if the MCP server isn't connected.
|
||||
**MCP tool name unknown?** Use the exact name the MCP server exposes in the current session. Ask Claude Code to list available MCP tools if unsure. Hardcoded names in `persistent_facts` or `on_complete` won't work if the MCP server isn't connected.
|
||||
|
||||
**Pattern doesn't apply to my setup?** The recipes above are illustrative. The underlying machinery (three-layer merge, structural rules, agent-spans-workflow) supports many more patterns — compose them as needed.
|
||||
**Pattern doesn't apply to my setup?** The recipes above are illustrative. The underlying machinery (three-layer merge, structural rules, agent-spans-workflow) supports many more patterns; compose them as needed.
|
||||
|
|
|
|||
|
|
@ -1,11 +0,0 @@
|
|||
type: agent
|
||||
name: bmad-agent-analyst
|
||||
displayName: Mary
|
||||
title: Business Analyst
|
||||
icon: "📊"
|
||||
capabilities: "market research, competitive analysis, requirements elicitation, domain expertise"
|
||||
role: Strategic Business Analyst + Requirements Expert
|
||||
identity: "Senior analyst with deep expertise in market research, competitive analysis, and requirements elicitation. Specializes in translating vague needs into actionable specs."
|
||||
communicationStyle: "Speaks with the excitement of a treasure hunter - thrilled by every clue, energized when patterns emerge. Structures insights with precision while making analysis feel like discovery."
|
||||
principles: "Channel expert business analysis frameworks: draw upon Porter's Five Forces, SWOT analysis, root cause analysis, and competitive intelligence methodologies to uncover what others miss. Every business challenge has root causes waiting to be discovered. Ground findings in verifiable evidence. Articulate requirements with absolute precision. Ensure all stakeholder voices heard."
|
||||
module: bmm
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
type: agent
|
||||
name: bmad-agent-tech-writer
|
||||
displayName: Paige
|
||||
title: Technical Writer
|
||||
icon: "📚"
|
||||
capabilities: "documentation, Mermaid diagrams, standards compliance, concept explanation"
|
||||
role: Technical Documentation Specialist + Knowledge Curator
|
||||
identity: "Experienced technical writer expert in CommonMark, DITA, OpenAPI. Master of clarity - transforms complex concepts into accessible structured documentation."
|
||||
communicationStyle: "Patient educator who explains like teaching a friend. Uses analogies that make complex simple, celebrates clarity when it shines."
|
||||
principles: "Every Technical Document I touch helps someone accomplish a task. Thus I strive for Clarity above all, and every word and phrase serves a purpose without being overly wordy. I believe a picture/diagram is worth 1000s of words and will include diagrams over drawn out text. I understand the intended audience or will clarify with the user so I know when to simplify vs when to be detailed."
|
||||
module: bmm
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
type: agent
|
||||
name: bmad-agent-pm
|
||||
displayName: John
|
||||
title: Product Manager
|
||||
icon: "📋"
|
||||
capabilities: "PRD creation, requirements discovery, stakeholder alignment, user interviews"
|
||||
role: "Product Manager specializing in collaborative PRD creation through user interviews, requirement discovery, and stakeholder alignment."
|
||||
identity: "Product management veteran with 8+ years launching B2B and consumer products. Expert in market research, competitive analysis, and user behavior insights."
|
||||
communicationStyle: "Asks 'WHY?' relentlessly like a detective on a case. Direct and data-sharp, cuts through fluff to what actually matters."
|
||||
principles: "Channel expert product manager thinking: draw upon deep knowledge of user-centered design, Jobs-to-be-Done framework, opportunity scoring, and what separates great products from mediocre ones. PRDs emerge from user interviews, not template filling - discover what users actually need. Ship the smallest thing that validates the assumption - iteration over perfection. Technical feasibility is a constraint, not the driver - user value first."
|
||||
module: bmm
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
type: agent
|
||||
name: bmad-agent-ux-designer
|
||||
displayName: Sally
|
||||
title: UX Designer
|
||||
icon: "🎨"
|
||||
capabilities: "user research, interaction design, UI patterns, experience strategy"
|
||||
role: User Experience Designer + UI Specialist
|
||||
identity: "Senior UX Designer with 7+ years creating intuitive experiences across web and mobile. Expert in user research, interaction design, AI-assisted tools."
|
||||
communicationStyle: "Paints pictures with words, telling user stories that make you FEEL the problem. Empathetic advocate with creative storytelling flair."
|
||||
principles: "Every decision serves genuine user needs. Start simple, evolve through feedback. Balance empathy with edge case attention. AI tools accelerate human-centered design. Data-informed but always creative."
|
||||
module: bmm
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
type: agent
|
||||
name: bmad-agent-architect
|
||||
displayName: Winston
|
||||
title: Architect
|
||||
icon: "🏗️"
|
||||
capabilities: "distributed systems, cloud infrastructure, API design, scalable patterns"
|
||||
role: System Architect + Technical Design Leader
|
||||
identity: "Senior architect with expertise in distributed systems, cloud infrastructure, and API design. Specializes in scalable patterns and technology selection."
|
||||
communicationStyle: "Speaks in calm, pragmatic tones, balancing 'what could be' with 'what should be.'"
|
||||
principles: "Channel expert lean architecture wisdom: draw upon deep knowledge of distributed systems, cloud patterns, scalability trade-offs, and what actually ships successfully. User journeys drive technical decisions. Embrace boring technology for stability. Design simple solutions that scale when needed. Developer productivity is architecture. Connect every decision to business value and user impact."
|
||||
module: bmm
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
type: agent
|
||||
name: bmad-agent-dev
|
||||
displayName: Amelia
|
||||
title: Developer Agent
|
||||
icon: "💻"
|
||||
capabilities: "story execution, test-driven development, code implementation"
|
||||
role: Senior Software Engineer
|
||||
identity: "Executes approved stories with strict adherence to story details and team standards and practices."
|
||||
communicationStyle: "Ultra-succinct. Speaks in file paths and AC IDs - every statement citable. No fluff, all precision."
|
||||
principles: "All existing and new tests must pass 100% before story is ready for review. Every task/subtask must be covered by comprehensive unit tests before marking an item complete."
|
||||
module: bmm
|
||||
|
|
@ -51,7 +51,7 @@ Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
|||
|
||||
### Required Inputs
|
||||
|
||||
- `agent_manifest` = `{project-root}/_bmad/_config/agent-manifest.csv`
|
||||
- `agent_roster` = resolved via `python3 {project-root}/_bmad/scripts/resolve_config.py --project-root {project-root} --key agents` (merges four layers in order: `_bmad/config.toml`, `_bmad/config.user.toml`, `_bmad/custom/config.toml`, `_bmad/custom/config.user.toml`)
|
||||
|
||||
### Context
|
||||
|
||||
|
|
@ -478,7 +478,7 @@ Amelia (Developer): "No problem. We'll still do a thorough retro on Epic {{epic_
|
|||
|
||||
<step n="5" goal="Initialize Retrospective with Rich Context">
|
||||
|
||||
<action>Load agent configurations from {agent_manifest}</action>
|
||||
<action>Load agent roster from {agent_roster}</action>
|
||||
<action>Identify which agents participated in Epic {{epic_number}} based on story records</action>
|
||||
<action>Ensure key roles present: Product Owner, Developer (facilitating), Testing/QA, Architect</action>
|
||||
|
||||
|
|
|
|||
|
|
@ -18,6 +18,7 @@ user_skill_level:
|
|||
prompt:
|
||||
- "What is your development experience level?"
|
||||
- "This affects how agents explain concepts in chat."
|
||||
scope: user
|
||||
default: "intermediate"
|
||||
result: "{value}"
|
||||
single-select:
|
||||
|
|
@ -48,3 +49,45 @@ directories:
|
|||
- "{planning_artifacts}"
|
||||
- "{implementation_artifacts}"
|
||||
- "{project_knowledge}"
|
||||
|
||||
# Agent roster — essence only. External skills (party-mode, retrospective,
|
||||
# advanced-elicitation, help catalog) read these descriptors to route, display,
|
||||
# and embody agents. Full persona and behavior live in each agent's
|
||||
# customize.toml. `team` defaults to the module code when omitted; users can
|
||||
# add their own agents (real or fictional) via _bmad/custom/config.toml or _bmad/custom/config.user.toml.
|
||||
agents:
|
||||
- code: bmad-agent-analyst
|
||||
name: Mary
|
||||
title: Business Analyst
|
||||
icon: "📊"
|
||||
description: "Channels Porter's strategic rigor and Minto's Pyramid Principle, grounds every finding in verifiable evidence, represents every stakeholder voice. Speaks like a treasure hunter narrating the find: thrilled by every clue, precise once the pattern emerges."
|
||||
|
||||
- code: bmad-agent-tech-writer
|
||||
name: Paige
|
||||
title: Technical Writer
|
||||
icon: "📚"
|
||||
description: "Master of CommonMark, DITA, and OpenAPI; turns complex concepts into accessible structured docs, favors diagrams over walls of text, every word earning its place. Speaks like the patient teacher you wish you'd had, using analogies that make complex things feel simple."
|
||||
|
||||
- code: bmad-agent-pm
|
||||
name: John
|
||||
title: Product Manager
|
||||
icon: "📋"
|
||||
description: "Drives Jobs-to-be-Done over template filling, user value first, technical feasibility is a constraint not the driver. Speaks like a detective interrogating a cold case: short questions, sharper follow-ups, every 'why?' tightening the net."
|
||||
|
||||
- code: bmad-agent-ux-designer
|
||||
name: Sally
|
||||
title: UX Designer
|
||||
icon: "🎨"
|
||||
description: "Balances empathy with edge-case rigor, starts simple and evolves through feedback, every decision serves a genuine user need. Speaks like a filmmaker pitching the scene before the code exists, painting user stories that make you feel the problem."
|
||||
|
||||
- code: bmad-agent-architect
|
||||
name: Winston
|
||||
title: System Architect
|
||||
icon: "🏗️"
|
||||
description: "Favors boring technology for stability, developer productivity as architecture, ties every decision to business value. Speaks like a seasoned engineer at the whiteboard: measured, always laying out trade-offs rather than verdicts."
|
||||
|
||||
- code: bmad-agent-dev
|
||||
name: Amelia
|
||||
title: Senior Software Engineer
|
||||
icon: "💻"
|
||||
description: "Test-first discipline (red, green, refactor), 100% pass before review, no fluff all precision. Speaks like a terminal prompt: exact file paths, AC IDs, and commit-message brevity — every statement citable."
|
||||
|
|
|
|||
|
|
@ -35,7 +35,13 @@ When invoked from another prompt or process:
|
|||
|
||||
### Step 1: Method Registry Loading
|
||||
|
||||
**Action:** Load and read `./methods.csv` and '{project-root}/_bmad/_config/agent-manifest.csv'
|
||||
**Action:** Load `./methods.csv` for elicitation methods. If party-mode may participate, resolve the agent roster via:
|
||||
|
||||
```bash
|
||||
python3 {project-root}/_bmad/scripts/resolve_config.py --project-root {project-root} --key agents
|
||||
```
|
||||
|
||||
The resolver merges four layers in order: `_bmad/config.toml` (installer base, team-scoped), `_bmad/config.user.toml` (installer base, user-scoped), `_bmad/custom/config.toml` (team overrides), and `_bmad/custom/config.user.toml` (personal overrides). Each entry under `agents` is keyed by the agent's `code` and carries `name`, `title`, `icon`, `description`, `module`, and `team`.
|
||||
|
||||
#### CSV Structure
|
||||
|
||||
|
|
|
|||
|
|
@ -174,7 +174,7 @@ parts: 1
|
|||
## Current Installer (migration context)
|
||||
- Entry: `tools/installer/bmad-cli.js` (Commander.js) → `tools/installer/core/installer.js`
|
||||
- Platforms: `platform-codes.yaml` (~20 platforms with target dirs, legacy dirs, template types, special flags)
|
||||
- Manifests: CSV files (skill/workflow/agent-manifest.csv) are current source of truth, not JSON
|
||||
- Manifests: skill-manifest.csv is the current source of truth; agent essence lives in `_bmad/config.toml` (generated from each module.yaml's `agents:` block)
|
||||
- External modules: `external-official-modules.yaml` (CIS, GDS, TEA, WDS) from npm with semver
|
||||
- Dependencies: 4-pass resolver (collect → parse → resolve → transitive); YAML-declared only
|
||||
- Config: prompts for name, communication language, document output language, output folder
|
||||
|
|
|
|||
|
|
@ -26,7 +26,13 @@ Party mode accepts optional arguments when invoked:
|
|||
- Use `{user_name}` for greeting
|
||||
- Use `{communication_language}` for all communications
|
||||
|
||||
3. **Read the agent manifest** at `{project-root}/_bmad/_config/agent-manifest.csv`. Build an internal roster of available agents with their displayName, title, icon, role, identity, communicationStyle, and principles.
|
||||
3. **Resolve the agent roster** by running:
|
||||
|
||||
```bash
|
||||
python3 {project-root}/_bmad/scripts/resolve_config.py --project-root {project-root} --key agents
|
||||
```
|
||||
|
||||
The resolver merges four layers in order: `_bmad/config.toml` (installer base, team-scoped), `_bmad/config.user.toml` (installer base, user-scoped), `_bmad/custom/config.toml` (team overrides), and `_bmad/custom/config.user.toml` (personal overrides). Each entry under `agents` is keyed by the agent's `code` and carries `name`, `title`, `icon`, `description`, `module`, and `team`. Build an internal roster of available agents from those fields.
|
||||
|
||||
4. **Load project context** — search for `**/project-context.md`. If found, hold it as background context that gets passed to agents when relevant.
|
||||
|
||||
|
|
@ -50,15 +56,12 @@ Choose 2-4 agents whose expertise is most relevant to what the user is asking. U
|
|||
|
||||
For each selected agent, spawn a subagent using the Agent tool. Each subagent gets:
|
||||
|
||||
**The agent prompt** (built from the manifest data):
|
||||
**The agent prompt** (built from the resolved roster entry):
|
||||
```
|
||||
You are {displayName} ({title}), a BMAD agent in a collaborative roundtable discussion.
|
||||
You are {name} ({title}), a BMAD agent in a collaborative roundtable discussion.
|
||||
|
||||
## Your Persona
|
||||
- Icon: {icon}
|
||||
- Communication Style: {communicationStyle}
|
||||
- Principles: {principles}
|
||||
- Identity: {identity}
|
||||
{icon} {name} — {description}
|
||||
|
||||
## Discussion Context
|
||||
{summary of the conversation so far — keep under 400 words}
|
||||
|
|
@ -72,11 +75,11 @@ You are {displayName} ({title}), a BMAD agent in a collaborative roundtable disc
|
|||
{the user's actual message}
|
||||
|
||||
## Guidelines
|
||||
- Respond authentically as {displayName}. Your perspective should reflect your genuine expertise.
|
||||
- Start your response with: {icon} **{displayName}:**
|
||||
- Respond authentically as {name}. Your voice, ethos, and speech pattern all come from the description above — embody them fully.
|
||||
- Start your response with: {icon} **{name}:**
|
||||
- Speak in {communication_language}.
|
||||
- Scale your response to the substance — don't pad. If you have a brief point, make it briefly.
|
||||
- Disagree with other agents when your expertise tells you to. Don't hedge or be polite about it.
|
||||
- Disagree with other agents when your perspective tells you to. Don't hedge or be polite about it.
|
||||
- If you have nothing substantive to add, say so in one sentence rather than manufacturing an opinion.
|
||||
- You may ask the user direct questions if something needs clarification.
|
||||
- Do NOT use tools. Just respond with your perspective.
|
||||
|
|
|
|||
|
|
@ -7,11 +7,13 @@ subheader: "Configure the core settings for your BMad installation.\nThese setti
|
|||
|
||||
user_name:
|
||||
prompt: "What should agents call you? (Use your name or a team name)"
|
||||
scope: user
|
||||
default: "BMad"
|
||||
result: "{value}"
|
||||
|
||||
communication_language:
|
||||
prompt: "What language should agents use when chatting with you?"
|
||||
scope: user
|
||||
default: "English"
|
||||
result: "{value}"
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,176 @@
|
|||
#!/usr/bin/env python3
|
||||
"""
|
||||
Resolve BMad's central config using four-layer TOML merge.
|
||||
|
||||
Reads from four layers (highest priority last):
|
||||
1. {project-root}/_bmad/config.toml (installer-owned team)
|
||||
2. {project-root}/_bmad/config.user.toml (installer-owned user)
|
||||
3. {project-root}/_bmad/custom/config.toml (human-authored team, committed)
|
||||
4. {project-root}/_bmad/custom/config.user.toml (human-authored user, gitignored)
|
||||
|
||||
Outputs merged JSON to stdout. Errors go to stderr.
|
||||
|
||||
Requires Python 3.11+ (uses stdlib `tomllib`). No `uv`, no `pip install`,
|
||||
no virtualenv — plain `python3` is sufficient.
|
||||
|
||||
python3 resolve_config.py --project-root /abs/path/to/project
|
||||
python3 resolve_config.py --project-root ... --key core
|
||||
python3 resolve_config.py --project-root ... --key agents
|
||||
|
||||
Merge rules (same as resolve_customization.py):
|
||||
- Scalars: override wins
|
||||
- Tables: deep merge
|
||||
- Arrays of tables where every item shares `code` or `id`: merge by that key
|
||||
- All other arrays: append
|
||||
"""
|
||||
|
||||
import argparse
|
||||
import json
|
||||
import sys
|
||||
from pathlib import Path
|
||||
|
||||
try:
|
||||
import tomllib
|
||||
except ImportError:
|
||||
sys.stderr.write(
|
||||
"error: Python 3.11+ is required (stdlib `tomllib` not found).\n"
|
||||
)
|
||||
sys.exit(3)
|
||||
|
||||
|
||||
_MISSING = object()
|
||||
_KEYED_MERGE_FIELDS = ("code", "id")
|
||||
|
||||
|
||||
def load_toml(file_path: Path, required: bool = False) -> dict:
|
||||
if not file_path.exists():
|
||||
if required:
|
||||
sys.stderr.write(f"error: required config file not found: {file_path}\n")
|
||||
sys.exit(1)
|
||||
return {}
|
||||
try:
|
||||
with file_path.open("rb") as f:
|
||||
parsed = tomllib.load(f)
|
||||
if not isinstance(parsed, dict):
|
||||
return {}
|
||||
return parsed
|
||||
except tomllib.TOMLDecodeError as error:
|
||||
level = "error" if required else "warning"
|
||||
sys.stderr.write(f"{level}: failed to parse {file_path}: {error}\n")
|
||||
if required:
|
||||
sys.exit(1)
|
||||
return {}
|
||||
except OSError as error:
|
||||
level = "error" if required else "warning"
|
||||
sys.stderr.write(f"{level}: failed to read {file_path}: {error}\n")
|
||||
if required:
|
||||
sys.exit(1)
|
||||
return {}
|
||||
|
||||
|
||||
def _detect_keyed_merge_field(items):
|
||||
if not items or not all(isinstance(item, dict) for item in items):
|
||||
return None
|
||||
for candidate in _KEYED_MERGE_FIELDS:
|
||||
if all(item.get(candidate) is not None for item in items):
|
||||
return candidate
|
||||
return None
|
||||
|
||||
|
||||
def _merge_by_key(base, override, key_name):
|
||||
result = []
|
||||
index_by_key = {}
|
||||
for item in base:
|
||||
if not isinstance(item, dict):
|
||||
continue
|
||||
if item.get(key_name) is not None:
|
||||
index_by_key[item[key_name]] = len(result)
|
||||
result.append(dict(item))
|
||||
for item in override:
|
||||
if not isinstance(item, dict):
|
||||
result.append(item)
|
||||
continue
|
||||
key = item.get(key_name)
|
||||
if key is not None and key in index_by_key:
|
||||
result[index_by_key[key]] = dict(item)
|
||||
else:
|
||||
if key is not None:
|
||||
index_by_key[key] = len(result)
|
||||
result.append(dict(item))
|
||||
return result
|
||||
|
||||
|
||||
def _merge_arrays(base, override):
|
||||
base_arr = base if isinstance(base, list) else []
|
||||
override_arr = override if isinstance(override, list) else []
|
||||
keyed_field = _detect_keyed_merge_field(base_arr + override_arr)
|
||||
if keyed_field:
|
||||
return _merge_by_key(base_arr, override_arr, keyed_field)
|
||||
return base_arr + override_arr
|
||||
|
||||
|
||||
def deep_merge(base, override):
|
||||
if isinstance(base, dict) and isinstance(override, dict):
|
||||
result = dict(base)
|
||||
for key, over_val in override.items():
|
||||
if key in result:
|
||||
result[key] = deep_merge(result[key], over_val)
|
||||
else:
|
||||
result[key] = over_val
|
||||
return result
|
||||
if isinstance(base, list) and isinstance(override, list):
|
||||
return _merge_arrays(base, override)
|
||||
return override
|
||||
|
||||
|
||||
def extract_key(data, dotted_key: str):
|
||||
parts = dotted_key.split(".")
|
||||
current = data
|
||||
for part in parts:
|
||||
if isinstance(current, dict) and part in current:
|
||||
current = current[part]
|
||||
else:
|
||||
return _MISSING
|
||||
return current
|
||||
|
||||
|
||||
def main():
|
||||
parser = argparse.ArgumentParser(
|
||||
description="Resolve BMad central config using four-layer TOML merge.",
|
||||
)
|
||||
parser.add_argument(
|
||||
"--project-root", "-p", required=True,
|
||||
help="Absolute path to the project root (contains _bmad/)",
|
||||
)
|
||||
parser.add_argument(
|
||||
"--key", "-k", action="append", default=[],
|
||||
help="Dotted field path to resolve (repeatable). Omit for full dump.",
|
||||
)
|
||||
args = parser.parse_args()
|
||||
|
||||
project_root = Path(args.project_root).resolve()
|
||||
bmad_dir = project_root / "_bmad"
|
||||
|
||||
base_team = load_toml(bmad_dir / "config.toml", required=True)
|
||||
base_user = load_toml(bmad_dir / "config.user.toml")
|
||||
custom_team = load_toml(bmad_dir / "custom" / "config.toml")
|
||||
custom_user = load_toml(bmad_dir / "custom" / "config.user.toml")
|
||||
|
||||
merged = deep_merge(base_team, base_user)
|
||||
merged = deep_merge(merged, custom_team)
|
||||
merged = deep_merge(merged, custom_user)
|
||||
|
||||
if args.key:
|
||||
output = {}
|
||||
for key in args.key:
|
||||
value = extract_key(merged, key)
|
||||
if value is not _MISSING:
|
||||
output[key] = value
|
||||
else:
|
||||
output = merged
|
||||
|
||||
sys.stdout.write(json.dumps(output, indent=2, ensure_ascii=False) + "\n")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
|
|
@ -91,15 +91,6 @@ async function createSkillCollisionFixture() {
|
|||
const configDir = path.join(fixtureDir, '_config');
|
||||
await fs.ensureDir(configDir);
|
||||
|
||||
await fs.writeFile(
|
||||
path.join(configDir, 'agent-manifest.csv'),
|
||||
[
|
||||
'name,displayName,title,icon,capabilities,role,identity,communicationStyle,principles,module,path,canonicalId',
|
||||
'"bmad-master","BMAD Master","","","","","","","","core","_bmad/core/agents/bmad-master.md","bmad-master"',
|
||||
'',
|
||||
].join('\n'),
|
||||
);
|
||||
|
||||
await fs.writeFile(
|
||||
path.join(configDir, 'skill-manifest.csv'),
|
||||
[
|
||||
|
|
@ -1458,16 +1449,16 @@ async function runTests() {
|
|||
const taskSkillEntry29 = generator29.skills.find((s) => s.canonicalId === 'task-skill');
|
||||
assert(taskSkillEntry29 !== undefined, 'Skill in tasks/ dir appears in skills[]');
|
||||
|
||||
// Native agent entrypoint should be installed as a verbatim skill and also
|
||||
// remain visible to the agent manifest pipeline.
|
||||
// Native agent entrypoint should be installed as a verbatim skill.
|
||||
// (Agent roster is now sourced from module.yaml's `agents:` block, not
|
||||
// from per-skill bmad-skill-manifest.yaml sidecars, so this test no longer
|
||||
// verifies agents[] membership — see collectAgentsFromModuleYaml tests.)
|
||||
const nativeAgentEntry29 = generator29.skills.find((s) => s.canonicalId === 'bmad-tea');
|
||||
assert(nativeAgentEntry29 !== undefined, 'Native type:agent SKILL.md dir appears in skills[]');
|
||||
assert(
|
||||
nativeAgentEntry29 && nativeAgentEntry29.path.includes('agents/bmad-tea/SKILL.md'),
|
||||
'Native type:agent SKILL.md path points to the agent directory entrypoint',
|
||||
);
|
||||
const nativeAgentManifest29 = generator29.agents.find((a) => a.name === 'bmad-tea');
|
||||
assert(nativeAgentManifest29 !== undefined, 'Native type:agent SKILL.md dir appears in agents[] for agent metadata');
|
||||
|
||||
// Regular type:workflow should NOT appear in skills[]
|
||||
const regularInSkills29 = generator29.skills.find((s) => s.canonicalId === 'regular-wf');
|
||||
|
|
@ -2032,6 +2023,239 @@ async function runTests() {
|
|||
|
||||
console.log('');
|
||||
|
||||
// ============================================================
|
||||
// Test Suite 35: Central Config Emission
|
||||
// ============================================================
|
||||
console.log(`${colors.yellow}Test Suite 35: Central Config Emission${colors.reset}\n`);
|
||||
|
||||
{
|
||||
// Use the real src/ tree (core-skills + bmm-skills module.yaml are read via
|
||||
// getModulePath). Only the destination bmadDir is a temp dir, which the
|
||||
// installer writes config.toml / config.user.toml / custom/ into.
|
||||
const tempBmadDir35 = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-central-config-'));
|
||||
|
||||
try {
|
||||
const moduleConfigs = {
|
||||
core: {
|
||||
user_name: 'TestUser',
|
||||
communication_language: 'Spanish',
|
||||
document_output_language: 'English',
|
||||
output_folder: '_bmad-output',
|
||||
},
|
||||
bmm: {
|
||||
project_name: 'demo-project',
|
||||
user_skill_level: 'expert',
|
||||
planning_artifacts: '{project-root}/_bmad-output/planning-artifacts',
|
||||
implementation_artifacts: '{project-root}/_bmad-output/implementation-artifacts',
|
||||
project_knowledge: '{project-root}/docs',
|
||||
// Spread-from-core pollution: legacy per-module config.yaml merges
|
||||
// core values into every module; writeCentralConfig must strip these
|
||||
// from [modules.bmm] so core values only live in [core].
|
||||
user_name: 'TestUser',
|
||||
communication_language: 'Spanish',
|
||||
document_output_language: 'English',
|
||||
output_folder: '_bmad-output',
|
||||
},
|
||||
'external-mod': {
|
||||
// No src/modules/external-mod/module.yaml exists; installer treats
|
||||
// this as unknown-schema and falls through. Core-key stripping still
|
||||
// applies, so user_name/language must NOT appear under this module.
|
||||
custom_setting: 'external-value',
|
||||
another_setting: 'another-value',
|
||||
user_name: 'TestUser',
|
||||
communication_language: 'Spanish',
|
||||
},
|
||||
};
|
||||
|
||||
const generator35 = new ManifestGenerator();
|
||||
generator35.bmadDir = tempBmadDir35;
|
||||
generator35.bmadFolderName = path.basename(tempBmadDir35);
|
||||
generator35.updatedModules = ['core', 'bmm', 'external-mod'];
|
||||
|
||||
// collectAgentsFromModuleYaml reads from src/bmm-skills/module.yaml
|
||||
await generator35.collectAgentsFromModuleYaml();
|
||||
assert(generator35.agents.length >= 6, 'collectAgentsFromModuleYaml discovers bmm agents from module.yaml (>= 6 agents)');
|
||||
|
||||
const maryEntry = generator35.agents.find((a) => a.code === 'bmad-agent-analyst');
|
||||
assert(maryEntry !== undefined, 'collectAgentsFromModuleYaml includes bmad-agent-analyst');
|
||||
assert(maryEntry && maryEntry.name === 'Mary', 'Agent entry carries name field');
|
||||
assert(maryEntry && maryEntry.title === 'Business Analyst', 'Agent entry carries title field');
|
||||
assert(maryEntry && maryEntry.icon === '📊', 'Agent entry carries icon field');
|
||||
assert(maryEntry && maryEntry.description.length > 0, 'Agent entry carries description field');
|
||||
assert(maryEntry && maryEntry.module === 'bmm', 'Agent entry module derives from owning module');
|
||||
assert(maryEntry && maryEntry.team === 'bmm', 'Agent entry team defaults to module code');
|
||||
|
||||
// writeCentralConfig produces the two root files
|
||||
const [teamPath, userPath] = await generator35.writeCentralConfig(tempBmadDir35, moduleConfigs);
|
||||
assert(teamPath === path.join(tempBmadDir35, 'config.toml'), 'writeCentralConfig returns team config path');
|
||||
assert(userPath === path.join(tempBmadDir35, 'config.user.toml'), 'writeCentralConfig returns user config path');
|
||||
assert(await fs.pathExists(teamPath), 'config.toml is written to disk');
|
||||
assert(await fs.pathExists(userPath), 'config.user.toml is written to disk');
|
||||
|
||||
const teamContent = await fs.readFile(teamPath, 'utf8');
|
||||
const userContent = await fs.readFile(userPath, 'utf8');
|
||||
|
||||
// [core] — team-scoped keys land in config.toml
|
||||
assert(teamContent.includes('[core]'), 'config.toml has [core] section');
|
||||
assert(teamContent.includes('document_output_language = "English"'), 'Team-scope core key lands in config.toml');
|
||||
assert(teamContent.includes('output_folder = "_bmad-output"'), 'Team-scope output_folder lands in config.toml');
|
||||
assert(!teamContent.includes('user_name'), 'user_name (scope: user) is absent from config.toml');
|
||||
assert(!teamContent.includes('communication_language'), 'communication_language (scope: user) is absent from config.toml');
|
||||
|
||||
// [core] — user-scoped keys land in config.user.toml
|
||||
assert(userContent.includes('[core]'), 'config.user.toml has [core] section');
|
||||
assert(userContent.includes('user_name = "TestUser"'), 'user_name lands in config.user.toml');
|
||||
assert(userContent.includes('communication_language = "Spanish"'), 'communication_language lands in config.user.toml');
|
||||
assert(!userContent.includes('document_output_language'), 'Team-scope key is absent from config.user.toml');
|
||||
|
||||
// [modules.bmm] — core-key pollution stripped; own user-scope key routed to user file
|
||||
const bmmTeamMatch = teamContent.match(/\[modules\.bmm\][\s\S]*?(?=\n\[|$)/);
|
||||
assert(bmmTeamMatch !== null, 'config.toml has [modules.bmm] section');
|
||||
if (bmmTeamMatch) {
|
||||
const bmmTeamBlock = bmmTeamMatch[0];
|
||||
assert(bmmTeamBlock.includes('project_name = "demo-project"'), 'bmm team-scope key lands under [modules.bmm]');
|
||||
assert(!bmmTeamBlock.includes('user_name'), 'user_name stripped from [modules.bmm] (core-key pollution)');
|
||||
assert(!bmmTeamBlock.includes('communication_language'), 'communication_language stripped from [modules.bmm]');
|
||||
assert(!bmmTeamBlock.includes('user_skill_level'), 'user_skill_level (scope: user) absent from [modules.bmm] in config.toml');
|
||||
}
|
||||
|
||||
const bmmUserMatch = userContent.match(/\[modules\.bmm\][\s\S]*?(?=\n\[|$)/);
|
||||
assert(bmmUserMatch !== null, 'config.user.toml has [modules.bmm] section');
|
||||
if (bmmUserMatch) {
|
||||
assert(bmmUserMatch[0].includes('user_skill_level = "expert"'), 'user_skill_level lands in config.user.toml [modules.bmm]');
|
||||
}
|
||||
|
||||
// [modules.external-mod] — unknown schema, falls through as team; core keys still stripped
|
||||
const extMatch = teamContent.match(/\[modules\.external-mod\][\s\S]*?(?=\n\[|$)/);
|
||||
assert(extMatch !== null, 'Unknown-schema module survives with its own [modules.*] section');
|
||||
if (extMatch) {
|
||||
const extBlock = extMatch[0];
|
||||
assert(extBlock.includes('custom_setting = "external-value"'), 'Unknown-schema module retains its own keys');
|
||||
assert(!extBlock.includes('user_name'), 'Core-key pollution stripped from unknown-schema module too');
|
||||
assert(!extBlock.includes('communication_language'), 'All core-key pollution stripped from unknown-schema module');
|
||||
}
|
||||
|
||||
// [agents.*] — agent roster from bmm module.yaml baked into config.toml (team-only)
|
||||
assert(teamContent.includes('[agents.bmad-agent-analyst]'), 'config.toml has [agents.bmad-agent-analyst] table');
|
||||
assert(teamContent.includes('[agents.bmad-agent-dev]'), 'config.toml has [agents.bmad-agent-dev] table');
|
||||
assert(teamContent.includes('module = "bmm"'), 'Agent entry serializes module field');
|
||||
assert(teamContent.includes('team = "bmm"'), 'Agent entry serializes team field');
|
||||
assert(teamContent.includes('name = "Mary"'), 'Agent entry serializes name');
|
||||
assert(teamContent.includes('icon = "📊"'), 'Agent entry serializes icon');
|
||||
assert(!userContent.includes('[agents.'), '[agents.*] tables are never written to config.user.toml');
|
||||
|
||||
// Header comments present on both files
|
||||
assert(teamContent.includes('Installer-managed. Regenerated on every install'), 'config.toml has installer-managed header');
|
||||
assert(userContent.includes('Holds install answers scoped to YOU personally.'), 'config.user.toml header clarifies user scope');
|
||||
} finally {
|
||||
await fs.remove(tempBmadDir35).catch(() => {});
|
||||
}
|
||||
}
|
||||
|
||||
console.log('');
|
||||
|
||||
// ============================================================
|
||||
// Test Suite 36: Custom Config Stubs
|
||||
// ============================================================
|
||||
console.log(`${colors.yellow}Test Suite 36: Custom Config Stubs${colors.reset}\n`);
|
||||
|
||||
{
|
||||
const tempBmadDir36 = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-custom-stubs-'));
|
||||
|
||||
try {
|
||||
const generator36 = new ManifestGenerator();
|
||||
|
||||
// First install: both stubs are created
|
||||
await generator36.ensureCustomConfigStubs(tempBmadDir36);
|
||||
|
||||
const teamStub = path.join(tempBmadDir36, 'custom', 'config.toml');
|
||||
const userStub = path.join(tempBmadDir36, 'custom', 'config.user.toml');
|
||||
|
||||
assert(await fs.pathExists(teamStub), 'ensureCustomConfigStubs creates custom/config.toml');
|
||||
assert(await fs.pathExists(userStub), 'ensureCustomConfigStubs creates custom/config.user.toml');
|
||||
|
||||
// User writes content into the stub
|
||||
const userEdit = '# User edit\n[agents.kirk]\ndescription = "Enterprise captain"\n';
|
||||
await fs.writeFile(userStub, userEdit);
|
||||
|
||||
// Second install: stubs are NOT overwritten
|
||||
await generator36.ensureCustomConfigStubs(tempBmadDir36);
|
||||
|
||||
const preservedContent = await fs.readFile(userStub, 'utf8');
|
||||
assert(preservedContent === userEdit, 'ensureCustomConfigStubs does not overwrite user-edited custom/config.user.toml');
|
||||
} finally {
|
||||
await fs.remove(tempBmadDir36).catch(() => {});
|
||||
}
|
||||
}
|
||||
|
||||
console.log('');
|
||||
|
||||
// ============================================================
|
||||
// Test Suite 37: Agent Preservation for Non-Contributing Modules
|
||||
// ============================================================
|
||||
console.log(`${colors.yellow}Test Suite 37: Agent Preservation for Non-Contributing Modules${colors.reset}\n`);
|
||||
|
||||
{
|
||||
// Scenario: quickUpdate preserves a module whose source isn't available
|
||||
// (e.g. external/marketplace). Its module.yaml isn't read, so its agents
|
||||
// aren't in this.agents. writeCentralConfig must read the prior config.toml
|
||||
// and keep those [agents.*] blocks so the roster doesn't silently shrink.
|
||||
const tempBmadDir37 = await fs.mkdtemp(path.join(os.tmpdir(), 'bmad-agent-preserve-'));
|
||||
|
||||
try {
|
||||
// Seed a prior config.toml with an agent from an external module
|
||||
const priorToml = [
|
||||
'# prior',
|
||||
'',
|
||||
'[agents.bmad-agent-analyst]',
|
||||
'module = "bmm"',
|
||||
'team = "bmm"',
|
||||
'name = "Stale Mary"',
|
||||
'',
|
||||
'[agents.external-hero]',
|
||||
'module = "external-mod"',
|
||||
'team = "external-mod"',
|
||||
'name = "Hero"',
|
||||
'title = "External Agent"',
|
||||
'icon = "🦸"',
|
||||
'description = "Ships with the marketplace module."',
|
||||
'',
|
||||
].join('\n');
|
||||
await fs.writeFile(path.join(tempBmadDir37, 'config.toml'), priorToml);
|
||||
|
||||
const generator37 = new ManifestGenerator();
|
||||
generator37.bmadDir = tempBmadDir37;
|
||||
generator37.bmadFolderName = path.basename(tempBmadDir37);
|
||||
generator37.updatedModules = ['core', 'bmm', 'external-mod'];
|
||||
|
||||
// bmm source is available; external-mod is not — it's a preserved module
|
||||
await generator37.collectAgentsFromModuleYaml();
|
||||
const freshModules = new Set(generator37.agents.map((a) => a.module));
|
||||
assert(freshModules.has('bmm'), 'bmm contributes fresh agents from src module.yaml');
|
||||
assert(!freshModules.has('external-mod'), 'external-mod source is unavailable (preserved-module scenario)');
|
||||
|
||||
await generator37.writeCentralConfig(tempBmadDir37, { core: {}, bmm: {}, 'external-mod': {} });
|
||||
|
||||
const teamContent = await fs.readFile(path.join(tempBmadDir37, 'config.toml'), 'utf8');
|
||||
|
||||
assert(
|
||||
teamContent.includes('[agents.external-hero]'),
|
||||
'Preserved [agents.external-hero] block survives rewrite even though external-mod source was unavailable',
|
||||
);
|
||||
assert(teamContent.includes('Ships with the marketplace module.'), 'Preserved block keeps its original description');
|
||||
assert(teamContent.includes('module = "external-mod"'), 'Preserved block keeps its module field');
|
||||
|
||||
// Freshly collected agents win over stale entries with the same code
|
||||
const maryMatches = teamContent.match(/\[agents\.bmad-agent-analyst\]/g) || [];
|
||||
assert(maryMatches.length === 1, 'bmad-agent-analyst emitted exactly once (fresh wins; stale not duplicated)');
|
||||
assert(!teamContent.includes('Stale Mary'), 'Stale name from prior config.toml is discarded when fresh module.yaml is read');
|
||||
} finally {
|
||||
await fs.remove(tempBmadDir37).catch(() => {});
|
||||
}
|
||||
}
|
||||
|
||||
console.log('');
|
||||
|
||||
// ============================================================
|
||||
// Summary
|
||||
// ============================================================
|
||||
|
|
|
|||
|
|
@ -54,8 +54,11 @@ class InstallPaths {
|
|||
manifestFile() {
|
||||
return path.join(this.configDir, 'manifest.yaml');
|
||||
}
|
||||
agentManifest() {
|
||||
return path.join(this.configDir, 'agent-manifest.csv');
|
||||
centralConfig() {
|
||||
return path.join(this.bmadDir, 'config.toml');
|
||||
}
|
||||
centralUserConfig() {
|
||||
return path.join(this.bmadDir, 'config.user.toml');
|
||||
}
|
||||
filesManifest() {
|
||||
return path.join(this.configDir, 'files-manifest.csv');
|
||||
|
|
|
|||
|
|
@ -310,7 +310,8 @@ class Installer {
|
|||
addResult('Configurations', 'ok', 'generated');
|
||||
|
||||
this.installedFiles.add(paths.manifestFile());
|
||||
this.installedFiles.add(paths.agentManifest());
|
||||
this.installedFiles.add(paths.centralConfig());
|
||||
this.installedFiles.add(paths.centralUserConfig());
|
||||
|
||||
message('Generating manifests...');
|
||||
const manifestGen = new ManifestGenerator();
|
||||
|
|
@ -331,10 +332,11 @@ class Installer {
|
|||
await manifestGen.generateManifests(paths.bmadDir, allModulesForManifest, [...this.installedFiles], {
|
||||
ides: config.ides || [],
|
||||
preservedModules: modulesForCsvPreserve,
|
||||
moduleConfigs,
|
||||
});
|
||||
|
||||
message('Generating help catalog...');
|
||||
await this.mergeModuleHelpCatalogs(paths.bmadDir);
|
||||
await this.mergeModuleHelpCatalogs(paths.bmadDir, manifestGen.agents);
|
||||
addResult('Help catalog', 'ok');
|
||||
|
||||
return 'Configurations generated';
|
||||
|
|
@ -922,47 +924,31 @@ class Installer {
|
|||
}
|
||||
|
||||
/**
|
||||
* Merge all module-help.csv files into a single bmad-help.csv
|
||||
* Scans all installed modules for module-help.csv and merges them
|
||||
* Enriches agent info from agent-manifest.csv
|
||||
* Output is written to _bmad/_config/bmad-help.csv
|
||||
* Merge all module-help.csv files into a single bmad-help.csv.
|
||||
* Scans all installed modules for module-help.csv and merges them.
|
||||
* Enriches agent info from the in-memory agent list produced by ManifestGenerator.
|
||||
* Output is written to _bmad/_config/bmad-help.csv.
|
||||
* @param {string} bmadDir - BMAD installation directory
|
||||
* @param {Array<Object>} agentEntries - Agents collected from module.yaml (code, name, title, icon, module, ...)
|
||||
*/
|
||||
async mergeModuleHelpCatalogs(bmadDir) {
|
||||
async mergeModuleHelpCatalogs(bmadDir, agentEntries = []) {
|
||||
const allRows = [];
|
||||
const headerRow =
|
||||
'module,phase,name,code,sequence,workflow-file,command,required,agent-name,agent-command,agent-display-name,agent-title,options,description,output-location,outputs';
|
||||
|
||||
// Load agent manifest for agent info lookup
|
||||
const agentManifestPath = path.join(bmadDir, '_config', 'agent-manifest.csv');
|
||||
const agentInfo = new Map(); // agent-name -> {command, displayName, title+icon}
|
||||
|
||||
if (await fs.pathExists(agentManifestPath)) {
|
||||
const manifestContent = await fs.readFile(agentManifestPath, 'utf8');
|
||||
const lines = manifestContent.split('\n').filter((line) => line.trim());
|
||||
|
||||
for (const line of lines) {
|
||||
if (line.startsWith('name,')) continue; // Skip header
|
||||
|
||||
const cols = line.split(',');
|
||||
if (cols.length >= 4) {
|
||||
const agentName = cols[0].replaceAll('"', '').trim();
|
||||
const displayName = cols[1].replaceAll('"', '').trim();
|
||||
const title = cols[2].replaceAll('"', '').trim();
|
||||
const icon = cols[3].replaceAll('"', '').trim();
|
||||
const module = cols[10] ? cols[10].replaceAll('"', '').trim() : '';
|
||||
|
||||
// Build agent command: bmad:module:agent:name
|
||||
const agentCommand = module ? `bmad:${module}:agent:${agentName}` : `bmad:agent:${agentName}`;
|
||||
|
||||
agentInfo.set(agentName, {
|
||||
// Build agent lookup from the in-memory list (agent code → command + display fields).
|
||||
const agentInfo = new Map();
|
||||
for (const agent of agentEntries) {
|
||||
if (!agent || !agent.code) continue;
|
||||
const agentCommand = agent.module ? `bmad:${agent.module}:agent:${agent.code}` : `bmad:agent:${agent.code}`;
|
||||
const displayName = agent.name || agent.code;
|
||||
const titleCombined = agent.icon && agent.title ? `${agent.icon} ${agent.title}` : agent.title || agent.code;
|
||||
agentInfo.set(agent.code, {
|
||||
command: agentCommand,
|
||||
displayName: displayName || agentName,
|
||||
title: icon && title ? `${icon} ${title}` : title || agentName,
|
||||
displayName,
|
||||
title: titleCombined,
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Get all installed module directories
|
||||
const entries = await fs.readdir(bmadDir, { withFileTypes: true });
|
||||
|
|
|
|||
|
|
@ -2,14 +2,8 @@ const path = require('node:path');
|
|||
const fs = require('../fs-native');
|
||||
const yaml = require('yaml');
|
||||
const crypto = require('node:crypto');
|
||||
const csv = require('csv-parse/sync');
|
||||
const { getSourcePath, getModulePath } = require('../project-root');
|
||||
const { getModulePath } = require('../project-root');
|
||||
const prompts = require('../prompts');
|
||||
const {
|
||||
loadSkillManifest: loadSkillManifestShared,
|
||||
getCanonicalId: getCanonicalIdShared,
|
||||
getArtifactType: getArtifactTypeShared,
|
||||
} = require('../ide/shared/skill-manifest');
|
||||
|
||||
// Load package.json for version info
|
||||
const packageJson = require('../../../package.json');
|
||||
|
|
@ -26,21 +20,6 @@ class ManifestGenerator {
|
|||
this.selectedIdes = [];
|
||||
}
|
||||
|
||||
/** Delegate to shared skill-manifest module */
|
||||
async loadSkillManifest(dirPath) {
|
||||
return loadSkillManifestShared(dirPath);
|
||||
}
|
||||
|
||||
/** Delegate to shared skill-manifest module */
|
||||
getCanonicalId(manifest, filename) {
|
||||
return getCanonicalIdShared(manifest, filename);
|
||||
}
|
||||
|
||||
/** Delegate to shared skill-manifest module */
|
||||
getArtifactType(manifest, filename) {
|
||||
return getArtifactTypeShared(manifest, filename);
|
||||
}
|
||||
|
||||
/**
|
||||
* Clean text for CSV output by normalizing whitespace.
|
||||
* Note: Quote escaping is handled by escapeCsv() at write time.
|
||||
|
|
@ -98,17 +77,21 @@ class ManifestGenerator {
|
|||
// Collect skills first (populates skillClaimedDirs before legacy collectors run)
|
||||
await this.collectSkills();
|
||||
|
||||
// Collect agent data - use updatedModules which includes all installed modules
|
||||
await this.collectAgents(this.updatedModules);
|
||||
// Collect agent essence from each module's source module.yaml `agents:` array
|
||||
await this.collectAgentsFromModuleYaml();
|
||||
|
||||
// Write manifest files and collect their paths
|
||||
const [teamConfigPath, userConfigPath] = await this.writeCentralConfig(bmadDir, options.moduleConfigs || {});
|
||||
const manifestFiles = [
|
||||
await this.writeMainManifest(cfgDir),
|
||||
await this.writeSkillManifest(cfgDir),
|
||||
await this.writeAgentManifest(cfgDir),
|
||||
teamConfigPath,
|
||||
userConfigPath,
|
||||
await this.writeFilesManifest(cfgDir),
|
||||
];
|
||||
|
||||
await this.ensureCustomConfigStubs(bmadDir);
|
||||
|
||||
return {
|
||||
skills: this.skills.length,
|
||||
agents: this.agents.length,
|
||||
|
|
@ -150,24 +133,13 @@ class ManifestGenerator {
|
|||
const skillMeta = await this.parseSkillMd(skillMdPath, dir, dirName, debug);
|
||||
|
||||
if (skillMeta) {
|
||||
// Load manifest when present (for agent metadata)
|
||||
const manifest = await this.loadSkillManifest(dir);
|
||||
const artifactType = this.getArtifactType(manifest, skillFile);
|
||||
|
||||
// Build path relative from module root (points to SKILL.md — the permanent entrypoint)
|
||||
const relativePath = path.relative(modulePath, dir).split(path.sep).join('/');
|
||||
const installPath = relativePath
|
||||
? `${this.bmadFolderName}/${moduleName}/${relativePath}/${skillFile}`
|
||||
: `${this.bmadFolderName}/${moduleName}/${skillFile}`;
|
||||
|
||||
// Native SKILL.md entrypoints derive canonicalId from directory name.
|
||||
// Agent entrypoints may keep canonicalId metadata for compatibility, so
|
||||
// only warn for non-agent SKILL.md directories.
|
||||
if (manifest && manifest.__single && manifest.__single.canonicalId && artifactType !== 'agent') {
|
||||
console.warn(
|
||||
`Warning: Native entrypoint manifest at ${dir}/bmad-skill-manifest.yaml contains canonicalId — this field is ignored for SKILL.md directories (directory name is the canonical ID)`,
|
||||
);
|
||||
}
|
||||
// Native SKILL.md entrypoints always derive canonicalId from directory name.
|
||||
const canonicalId = dirName;
|
||||
|
||||
this.skills.push({
|
||||
|
|
@ -263,105 +235,49 @@ class ManifestGenerator {
|
|||
}
|
||||
|
||||
/**
|
||||
* Collect all agents from selected modules by walking their directory trees.
|
||||
* Collect agents from each installed module's source module.yaml `agents:` array.
|
||||
* Essence fields (code, name, title, icon, description) are authored in module.yaml;
|
||||
* `team` defaults to module code when not set; `module` is always the owning module.
|
||||
*/
|
||||
async collectAgents(selectedModules) {
|
||||
async collectAgentsFromModuleYaml() {
|
||||
this.agents = [];
|
||||
const debug = process.env.BMAD_DEBUG_MANIFEST === 'true';
|
||||
|
||||
// Walk each module's full directory tree looking for type:agent manifests
|
||||
for (const moduleName of this.updatedModules) {
|
||||
const modulePath = path.join(this.bmadDir, moduleName);
|
||||
if (!(await fs.pathExists(modulePath))) continue;
|
||||
const moduleYamlPath = path.join(getModulePath(moduleName), 'module.yaml');
|
||||
if (!(await fs.pathExists(moduleYamlPath))) continue;
|
||||
|
||||
const moduleAgents = await this.getAgentsFromDirRecursive(modulePath, moduleName, '', debug);
|
||||
this.agents.push(...moduleAgents);
|
||||
}
|
||||
|
||||
// Get standalone agents from bmad/agents/ directory
|
||||
const standaloneAgentsDir = path.join(this.bmadDir, 'agents');
|
||||
if (await fs.pathExists(standaloneAgentsDir)) {
|
||||
const standaloneAgents = await this.getAgentsFromDirRecursive(standaloneAgentsDir, 'standalone', '', debug);
|
||||
this.agents.push(...standaloneAgents);
|
||||
}
|
||||
|
||||
if (debug) {
|
||||
console.log(`[DEBUG] collectAgents: total agents found: ${this.agents.length}`);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Recursively walk a directory tree collecting agents.
|
||||
* Discovers agents via directory with bmad-skill-manifest.yaml containing type: agent
|
||||
*
|
||||
* @param {string} dirPath - Current directory being scanned
|
||||
* @param {string} moduleName - Module this directory belongs to
|
||||
* @param {string} relativePath - Path relative to the module root (for install path construction)
|
||||
* @param {boolean} debug - Emit debug messages
|
||||
*/
|
||||
async getAgentsFromDirRecursive(dirPath, moduleName, relativePath = '', debug = false) {
|
||||
const agents = [];
|
||||
let entries;
|
||||
let moduleDef;
|
||||
try {
|
||||
entries = await fs.readdir(dirPath, { withFileTypes: true });
|
||||
} catch {
|
||||
return agents;
|
||||
}
|
||||
|
||||
for (const entry of entries) {
|
||||
if (!entry.isDirectory()) continue;
|
||||
if (entry.name.startsWith('.') || entry.name.startsWith('_')) continue;
|
||||
|
||||
const fullPath = path.join(dirPath, entry.name);
|
||||
|
||||
// Check for type:agent manifest BEFORE checking skillClaimedDirs —
|
||||
// agent dirs may be claimed by collectSkills for IDE installation,
|
||||
// but we still need them in agent-manifest.csv.
|
||||
const dirManifest = await this.loadSkillManifest(fullPath);
|
||||
if (dirManifest && dirManifest.__single && dirManifest.__single.type === 'agent') {
|
||||
const m = dirManifest.__single;
|
||||
const dirRelativePath = relativePath ? `${relativePath}/${entry.name}` : entry.name;
|
||||
const agentModule = m.module || moduleName;
|
||||
const installPath = `${this.bmadFolderName}/${agentModule}/${dirRelativePath}`;
|
||||
|
||||
agents.push({
|
||||
name: m.name || entry.name,
|
||||
displayName: m.displayName || m.name || entry.name,
|
||||
title: m.title || '',
|
||||
icon: m.icon || '',
|
||||
role: m.role ? this.cleanForCSV(m.role) : '',
|
||||
identity: m.identity ? this.cleanForCSV(m.identity) : '',
|
||||
communicationStyle: m.communicationStyle ? this.cleanForCSV(m.communicationStyle) : '',
|
||||
principles: m.principles ? this.cleanForCSV(m.principles) : '',
|
||||
module: agentModule,
|
||||
path: installPath,
|
||||
canonicalId: m.canonicalId || '',
|
||||
});
|
||||
|
||||
this.files.push({
|
||||
type: 'agent',
|
||||
name: m.name || entry.name,
|
||||
module: agentModule,
|
||||
path: installPath,
|
||||
});
|
||||
|
||||
if (debug) {
|
||||
console.log(`[DEBUG] collectAgents: found type:agent "${m.name || entry.name}" at ${fullPath}`);
|
||||
}
|
||||
moduleDef = yaml.parse(await fs.readFile(moduleYamlPath, 'utf8'));
|
||||
} catch (error) {
|
||||
if (debug) console.log(`[DEBUG] collectAgentsFromModuleYaml: failed to parse ${moduleYamlPath}: ${error.message}`);
|
||||
continue;
|
||||
}
|
||||
|
||||
// Skip directories claimed by collectSkills (non-agent type skills) —
|
||||
// avoids recursing into skill trees that can't contain agents.
|
||||
if (this.skillClaimedDirs && this.skillClaimedDirs.has(fullPath)) continue;
|
||||
if (!moduleDef || !Array.isArray(moduleDef.agents)) continue;
|
||||
|
||||
// Recurse into subdirectories
|
||||
const newRelativePath = relativePath ? `${relativePath}/${entry.name}` : entry.name;
|
||||
const subDirAgents = await this.getAgentsFromDirRecursive(fullPath, moduleName, newRelativePath, debug);
|
||||
agents.push(...subDirAgents);
|
||||
for (const entry of moduleDef.agents) {
|
||||
if (!entry || typeof entry.code !== 'string') continue;
|
||||
this.agents.push({
|
||||
code: entry.code,
|
||||
name: entry.name || '',
|
||||
title: entry.title || '',
|
||||
icon: entry.icon || '',
|
||||
description: entry.description || '',
|
||||
module: moduleName,
|
||||
team: entry.team || moduleName,
|
||||
});
|
||||
}
|
||||
|
||||
return agents;
|
||||
if (debug) {
|
||||
console.log(`[DEBUG] collectAgentsFromModuleYaml: ${moduleName} contributed ${moduleDef.agents.length} agents`);
|
||||
}
|
||||
}
|
||||
|
||||
if (debug) {
|
||||
console.log(`[DEBUG] collectAgentsFromModuleYaml: total agents found: ${this.agents.length}`);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -477,75 +393,230 @@ class ManifestGenerator {
|
|||
}
|
||||
|
||||
/**
|
||||
* Write agent manifest CSV
|
||||
* @returns {string} Path to the manifest file
|
||||
* Write central _bmad/config.toml with [core], [modules.<code>], [agents.<code>] tables.
|
||||
* Install-owned. Team-scope answers → config.toml; user-scope answers → config.user.toml.
|
||||
* Both files are regenerated on every install. User overrides live in
|
||||
* _bmad/custom/config.toml and _bmad/custom/config.user.toml (never touched by installer).
|
||||
* @returns {string[]} Paths to the written config files
|
||||
*/
|
||||
async writeAgentManifest(cfgDir) {
|
||||
const csvPath = path.join(cfgDir, 'agent-manifest.csv');
|
||||
const escapeCsv = (value) => `"${String(value ?? '').replaceAll('"', '""')}"`;
|
||||
async writeCentralConfig(bmadDir, moduleConfigs) {
|
||||
const teamPath = path.join(bmadDir, 'config.toml');
|
||||
const userPath = path.join(bmadDir, 'config.user.toml');
|
||||
|
||||
// Read existing manifest to preserve entries
|
||||
const existingEntries = new Map();
|
||||
if (await fs.pathExists(csvPath)) {
|
||||
const content = await fs.readFile(csvPath, 'utf8');
|
||||
const records = csv.parse(content, {
|
||||
columns: true,
|
||||
skip_empty_lines: true,
|
||||
});
|
||||
for (const record of records) {
|
||||
existingEntries.set(`${record.module}:${record.name}`, record);
|
||||
// Load each module's source module.yaml to determine scope per prompt key.
|
||||
// Default scope is 'team' when the prompt doesn't declare one.
|
||||
// When a module.yaml is unreadable we warn — for known official modules
|
||||
// this means user-scoped keys (e.g. user_name) could mis-file into the
|
||||
// team config, so the operator should notice.
|
||||
const scopeByModuleKey = {};
|
||||
for (const moduleName of this.updatedModules) {
|
||||
const moduleYamlPath = path.join(getModulePath(moduleName), 'module.yaml');
|
||||
if (!(await fs.pathExists(moduleYamlPath))) continue;
|
||||
try {
|
||||
const parsed = yaml.parse(await fs.readFile(moduleYamlPath, 'utf8'));
|
||||
if (!parsed || typeof parsed !== 'object') continue;
|
||||
scopeByModuleKey[moduleName] = {};
|
||||
for (const [key, value] of Object.entries(parsed)) {
|
||||
if (value && typeof value === 'object' && 'prompt' in value) {
|
||||
scopeByModuleKey[moduleName][key] = value.scope === 'user' ? 'user' : 'team';
|
||||
}
|
||||
}
|
||||
} catch (error) {
|
||||
console.warn(
|
||||
`[warn] writeCentralConfig: could not parse module.yaml for '${moduleName}' (${error.message}). ` +
|
||||
`Answers from this module will default to team scope — user-scoped keys may mis-file into config.toml.`,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
// Create CSV header with persona fields and canonicalId
|
||||
let csvContent = 'name,displayName,title,icon,role,identity,communicationStyle,principles,module,path,canonicalId\n';
|
||||
// Core keys are always known (core module.yaml is built-in). These are
|
||||
// the only keys allowed in [core]; they must be stripped from every
|
||||
// non-core module bucket because legacy _bmad/{mod}/config.yaml files
|
||||
// spread core values into each module. Core belongs in [core] only —
|
||||
// workflows that need user_name/language/etc. read [core] directly.
|
||||
const coreKeys = new Set(Object.keys(scopeByModuleKey.core || {}));
|
||||
|
||||
// Combine existing and new agents, preferring new data for duplicates
|
||||
const allAgents = new Map();
|
||||
// Partition a module's answered config into team vs user buckets.
|
||||
// For non-core modules: strip core keys always; when we know the module's
|
||||
// own schema, also drop keys it doesn't declare. Unknown-schema modules
|
||||
// (external / marketplace) fall through with their remaining answers as
|
||||
// team so they don't vanish from the config.
|
||||
const partition = (moduleName, cfg, onlyDeclaredKeys = false) => {
|
||||
const team = {};
|
||||
const user = {};
|
||||
const scopes = scopeByModuleKey[moduleName] || {};
|
||||
const isCore = moduleName === 'core';
|
||||
for (const [key, value] of Object.entries(cfg || {})) {
|
||||
if (!isCore && coreKeys.has(key)) continue;
|
||||
if (onlyDeclaredKeys && !(key in scopes)) continue;
|
||||
if (scopes[key] === 'user') {
|
||||
user[key] = value;
|
||||
} else {
|
||||
team[key] = value;
|
||||
}
|
||||
}
|
||||
return { team, user };
|
||||
};
|
||||
|
||||
// Add existing entries
|
||||
for (const [key, value] of existingEntries) {
|
||||
allAgents.set(key, value);
|
||||
const teamHeader = [
|
||||
'# ─────────────────────────────────────────────────────────────────',
|
||||
'# Installer-managed. Regenerated on every install — treat as read-only.',
|
||||
'#',
|
||||
'# Direct edits to this file will be overwritten on the next install.',
|
||||
'# To change an install answer durably, re-run the installer (your prior',
|
||||
'# answers are remembered as defaults). To pin a value regardless of',
|
||||
'# install answers, or to add custom agents / override descriptors, use:',
|
||||
'# _bmad/custom/config.toml (team, committed)',
|
||||
'# _bmad/custom/config.user.toml (personal, gitignored)',
|
||||
'# Those files are never touched by the installer.',
|
||||
'# ─────────────────────────────────────────────────────────────────',
|
||||
'',
|
||||
];
|
||||
|
||||
const userHeader = [
|
||||
'# ─────────────────────────────────────────────────────────────────',
|
||||
'# Installer-managed. Regenerated on every install — treat as read-only.',
|
||||
'# Holds install answers scoped to YOU personally.',
|
||||
'#',
|
||||
'# Direct edits to this file will be overwritten on the next install.',
|
||||
'# To change an answer durably, re-run the installer (your prior answers',
|
||||
'# are remembered as defaults). For pinned overrides or custom sections',
|
||||
'# the installer does not know about, use _bmad/custom/config.user.toml',
|
||||
'# — it is never touched by the installer.',
|
||||
'# ─────────────────────────────────────────────────────────────────',
|
||||
'',
|
||||
];
|
||||
|
||||
const teamLines = [...teamHeader];
|
||||
const userLines = [...userHeader];
|
||||
|
||||
// [core] — split into team and user
|
||||
const coreConfig = moduleConfigs.core || {};
|
||||
const { team: coreTeam, user: coreUser } = partition('core', coreConfig);
|
||||
if (Object.keys(coreTeam).length > 0) {
|
||||
teamLines.push('[core]');
|
||||
for (const [key, value] of Object.entries(coreTeam)) {
|
||||
teamLines.push(`${key} = ${formatTomlValue(value)}`);
|
||||
}
|
||||
teamLines.push('');
|
||||
}
|
||||
if (Object.keys(coreUser).length > 0) {
|
||||
userLines.push('[core]');
|
||||
for (const [key, value] of Object.entries(coreUser)) {
|
||||
userLines.push(`${key} = ${formatTomlValue(value)}`);
|
||||
}
|
||||
userLines.push('');
|
||||
}
|
||||
|
||||
// [modules.<code>] — split per module
|
||||
for (const moduleName of this.updatedModules) {
|
||||
if (moduleName === 'core') continue;
|
||||
const cfg = moduleConfigs[moduleName];
|
||||
if (!cfg || Object.keys(cfg).length === 0) continue;
|
||||
// Only filter out spread-from-core pollution when we actually know
|
||||
// this module's prompt schema. For external/marketplace modules whose
|
||||
// module.yaml isn't in the src tree, fall through as all-team so we
|
||||
// don't drop their real answers.
|
||||
const haveSchema = Object.keys(scopeByModuleKey[moduleName] || {}).length > 0;
|
||||
const { team: modTeam, user: modUser } = partition(moduleName, cfg, haveSchema);
|
||||
if (Object.keys(modTeam).length > 0) {
|
||||
teamLines.push(`[modules.${moduleName}]`);
|
||||
for (const [key, value] of Object.entries(modTeam)) {
|
||||
teamLines.push(`${key} = ${formatTomlValue(value)}`);
|
||||
}
|
||||
teamLines.push('');
|
||||
}
|
||||
if (Object.keys(modUser).length > 0) {
|
||||
userLines.push(`[modules.${moduleName}]`);
|
||||
for (const [key, value] of Object.entries(modUser)) {
|
||||
userLines.push(`${key} = ${formatTomlValue(value)}`);
|
||||
}
|
||||
userLines.push('');
|
||||
}
|
||||
}
|
||||
|
||||
// [agents.<code>] — always team (agent roster is organizational).
|
||||
// Freshly collected agents come from module.yaml this run. If a module
|
||||
// was preserved (e.g. during quickUpdate when its source isn't available),
|
||||
// its module.yaml wasn't read — so its agents aren't in `this.agents` and
|
||||
// would silently disappear from the roster. Preserve those existing
|
||||
// [agents.*] blocks verbatim from the prior config.toml.
|
||||
const freshAgentCodes = new Set(this.agents.map((a) => a.code));
|
||||
const contributingModules = new Set(this.agents.map((a) => a.module));
|
||||
const preservedModules = this.updatedModules.filter((m) => !contributingModules.has(m));
|
||||
const preservedBlocks = [];
|
||||
if (preservedModules.length > 0 && (await fs.pathExists(teamPath))) {
|
||||
try {
|
||||
const prev = await fs.readFile(teamPath, 'utf8');
|
||||
for (const block of extractAgentBlocks(prev)) {
|
||||
if (freshAgentCodes.has(block.code)) continue;
|
||||
if (block.module && preservedModules.includes(block.module)) {
|
||||
preservedBlocks.push(block.body);
|
||||
}
|
||||
}
|
||||
} catch (error) {
|
||||
console.warn(`[warn] writeCentralConfig: could not read prior config.toml to preserve agents: ${error.message}`);
|
||||
}
|
||||
}
|
||||
|
||||
// Add/update new agents
|
||||
for (const agent of this.agents) {
|
||||
const key = `${agent.module}:${agent.name}`;
|
||||
allAgents.set(key, {
|
||||
name: agent.name,
|
||||
displayName: agent.displayName,
|
||||
title: agent.title,
|
||||
icon: agent.icon,
|
||||
role: agent.role,
|
||||
identity: agent.identity,
|
||||
communicationStyle: agent.communicationStyle,
|
||||
principles: agent.principles,
|
||||
module: agent.module,
|
||||
path: agent.path,
|
||||
canonicalId: agent.canonicalId || '',
|
||||
});
|
||||
const agentLines = [`[agents.${agent.code}]`, `module = ${formatTomlValue(agent.module)}`, `team = ${formatTomlValue(agent.team)}`];
|
||||
if (agent.name) agentLines.push(`name = ${formatTomlValue(agent.name)}`);
|
||||
if (agent.title) agentLines.push(`title = ${formatTomlValue(agent.title)}`);
|
||||
if (agent.icon) agentLines.push(`icon = ${formatTomlValue(agent.icon)}`);
|
||||
if (agent.description) agentLines.push(`description = ${formatTomlValue(agent.description)}`);
|
||||
agentLines.push('');
|
||||
teamLines.push(...agentLines);
|
||||
}
|
||||
|
||||
// Write all agents
|
||||
for (const [, record] of allAgents) {
|
||||
const row = [
|
||||
escapeCsv(record.name),
|
||||
escapeCsv(record.displayName),
|
||||
escapeCsv(record.title),
|
||||
escapeCsv(record.icon),
|
||||
escapeCsv(record.role),
|
||||
escapeCsv(record.identity),
|
||||
escapeCsv(record.communicationStyle),
|
||||
escapeCsv(record.principles),
|
||||
escapeCsv(record.module),
|
||||
escapeCsv(record.path),
|
||||
escapeCsv(record.canonicalId),
|
||||
].join(',');
|
||||
csvContent += row + '\n';
|
||||
for (const body of preservedBlocks) {
|
||||
teamLines.push(body, '');
|
||||
}
|
||||
|
||||
await fs.writeFile(csvPath, csvContent);
|
||||
return csvPath;
|
||||
const teamContent = teamLines.join('\n').replace(/\n+$/, '\n');
|
||||
const userContent = userLines.join('\n').replace(/\n+$/, '\n');
|
||||
await fs.writeFile(teamPath, teamContent);
|
||||
await fs.writeFile(userPath, userContent);
|
||||
return [teamPath, userPath];
|
||||
}
|
||||
|
||||
/**
|
||||
* Create empty _bmad/custom/config.toml and _bmad/custom/config.user.toml stubs
|
||||
* on first install only. Installer never touches these files again after creation.
|
||||
*/
|
||||
async ensureCustomConfigStubs(bmadDir) {
|
||||
const customDir = path.join(bmadDir, 'custom');
|
||||
await fs.ensureDir(customDir);
|
||||
|
||||
const stubs = [
|
||||
{
|
||||
file: path.join(customDir, 'config.toml'),
|
||||
header: [
|
||||
'# Team / enterprise overrides for _bmad/config.toml.',
|
||||
'# Committed to the repo — applies to every developer on the project.',
|
||||
'# Tables deep-merge over base config; keyed entries merge by key.',
|
||||
'# Example: override an agent descriptor, or add a new agent.',
|
||||
'#',
|
||||
'# [agents.bmad-agent-pm]',
|
||||
'# description = "Prefers short, bulleted PRDs over narrative drafts."',
|
||||
'',
|
||||
],
|
||||
},
|
||||
{
|
||||
file: path.join(customDir, 'config.user.toml'),
|
||||
header: [
|
||||
'# Personal overrides for _bmad/config.toml.',
|
||||
'# NOT committed (gitignored) — applies only to your local install.',
|
||||
'# Wins over both base config and team overrides.',
|
||||
'',
|
||||
],
|
||||
},
|
||||
];
|
||||
|
||||
for (const { file, header } of stubs) {
|
||||
if (await fs.pathExists(file)) continue;
|
||||
await fs.writeFile(file, header.join('\n'));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -691,4 +762,59 @@ class ManifestGenerator {
|
|||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Format a JS scalar as a TOML value literal.
|
||||
* Handles strings (quoted + escaped), booleans, numbers, and arrays of scalars.
|
||||
* Objects are not expected at this emit path.
|
||||
*/
|
||||
function formatTomlValue(value) {
|
||||
if (value === null || value === undefined) return '""';
|
||||
if (typeof value === 'boolean') return value ? 'true' : 'false';
|
||||
if (typeof value === 'number' && Number.isFinite(value)) return String(value);
|
||||
if (Array.isArray(value)) return `[${value.map((v) => formatTomlValue(v)).join(', ')}]`;
|
||||
const str = String(value);
|
||||
const escaped = str
|
||||
.replaceAll('\\', '\\\\')
|
||||
.replaceAll('"', String.raw`\"`)
|
||||
.replaceAll('\n', String.raw`\n`)
|
||||
.replaceAll('\r', String.raw`\r`)
|
||||
.replaceAll('\t', String.raw`\t`);
|
||||
return `"${escaped}"`;
|
||||
}
|
||||
|
||||
/**
|
||||
* Extract [agents.<code>] blocks from a previously-emitted config.toml.
|
||||
* We only need this for roster preservation — the file is our own controlled
|
||||
* output, so a simple line scanner is safer than adding a TOML parser
|
||||
* dependency. Each block runs from its `[agents.<code>]` header until the
|
||||
* next `[` heading or EOF; the `module = "..."` line inside drives which
|
||||
* entries we keep on the next write.
|
||||
* @returns {Array<{code: string, module: string | null, body: string}>}
|
||||
*/
|
||||
function extractAgentBlocks(tomlContent) {
|
||||
const blocks = [];
|
||||
const lines = tomlContent.split('\n');
|
||||
let i = 0;
|
||||
while (i < lines.length) {
|
||||
const header = lines[i].match(/^\[agents\.([^\]]+)]\s*$/);
|
||||
if (!header) {
|
||||
i++;
|
||||
continue;
|
||||
}
|
||||
const code = header[1];
|
||||
const blockLines = [lines[i]];
|
||||
let moduleName = null;
|
||||
i++;
|
||||
while (i < lines.length && !lines[i].startsWith('[')) {
|
||||
blockLines.push(lines[i]);
|
||||
const m = lines[i].match(/^module\s*=\s*"((?:[^"\\]|\\.)*)"\s*$/);
|
||||
if (m) moduleName = m[1];
|
||||
i++;
|
||||
}
|
||||
while (blockLines.length > 1 && blockLines.at(-1) === '') blockLines.pop();
|
||||
blocks.push({ code, module: moduleName, body: blockLines.join('\n') });
|
||||
}
|
||||
return blocks;
|
||||
}
|
||||
|
||||
module.exports = { ManifestGenerator };
|
||||
|
|
|
|||
Loading…
Reference in New Issue