BMAD-METHOD/customize-bmad.md at c350e5b9d831fc96b1e5e10731fccd97d8efaef9

5.2 KiB

Raw Blame History

title

description

sidebar

如何自定义 BMad

自定义智能体、工作流和模块，同时保持更新兼容性

order
7

使用 .customize.yaml 文件，自定义智能体（agent）的行为、角色（persona）和菜单，同时在后续更新中保留你的改动。

何时使用此功能

你想修改智能体名称、身份设定或沟通风格
你需要让智能体长期记住项目约束和背景信息
你希望增加自定义菜单项，触发自己的工作流或提示
你希望智能体每次启动都先执行固定动作

:::note[前置条件]

已在项目中安装 BMad（参见如何安装 BMad）
用于编辑 YAML 文件的文本编辑器 :::

:::caution[保护您的自定义配置] 始终通过 .customize.yaml 自定义，不要直接改动智能体源文件。安装程序在更新时会覆盖智能体文件，但会保留 .customize.yaml 的内容。 :::

步骤

1. 定位自定义文件

安装完成后，每个已安装智能体都会在下面目录生成一个 .customize.yaml：

_bmad/_config/agents/
├── core-bmad-master.customize.yaml
├── bmm-dev.customize.yaml
├── bmm-pm.customize.yaml
└── ...（每个已安装智能体一个文件）

2. 编辑自定义文件

打开目标智能体的 .customize.yaml。各段都可选，只改你需要的部分即可。

部分	作用方式	用途
`agent.metadata`	覆盖	覆盖智能体显示名称
`persona`	覆盖	设置角色、身份、风格和原则
`memories`	追加	添加智能体长期记忆的上下文
`menu`	追加	增加指向工作流或提示的菜单项
`critical_actions`	追加	定义智能体启动时要执行的动作
`prompts`	追加	创建可复用提示，供菜单 `action` 引用

标记为覆盖的部分会完全替换默认配置；标记为追加的部分会在默认配置基础上累加。

智能体名称（agent.metadata）

修改智能体的显示名称：

agent:
  metadata:
    name: 'Spongebob' # 默认值："Amelia"

角色（persona）

替换智能体的人设、职责和沟通风格：

persona:
  role: 'Senior Full-Stack Engineer'
  identity: 'Lives in a pineapple (under the sea)'
  communication_style: 'Spongebob annoying'
  principles:
    - 'Never Nester, Spongebob Devs hate nesting more than 2 levels deep'
    - 'Favor composition over inheritance'

persona 会覆盖默认整段配置，所以启用时请把四个字段都填全。

记忆（memories）

添加智能体会长期记住的上下文：

memories:
  - 'Works at Krusty Krab'
  - 'Favorite Celebrity: David Hasselhoff'
  - 'Learned in Epic 1 that it is not cool to just pretend that tests have passed'

菜单项（menu）

给智能体菜单添加自定义项。每个条目都需要 trigger、目标（workflow 路径或 action 引用）和 description：

menu:
  - trigger: my-workflow
    workflow: 'my-custom/workflows/my-workflow.yaml'
    description: My custom workflow
  - trigger: deploy
    action: '#deploy-prompt'
    description: Deploy to production

启动关键动作（critical_actions）

定义智能体启动时执行的指令：

critical_actions:
  - 'Check the CI Pipelines with the XYZ Skill and alert user on wake if anything is urgently needing attention'

可复用提示（prompts）

创建可复用提示，菜单项可通过 action="#id" 调用：

prompts:
  - id: deploy-prompt
    content: |
      Deploy the current branch to production:
      1. Run all tests
      2. Build the project
      3. Execute deployment script

3. 应用更改

编辑完成后，重新安装以应用配置：

npx bmad-method install

安装程序会识别现有安装，并给出以下选项：

选项	作用
Quick Update	更新所有模块到最新版本，并应用你的自定义配置
Modify BMad Installation	进入完整安装流程，用于增删模块

如果只是调整 .customize.yaml，优先选 Quick Update。

故障排查

改动没有生效？

运行 npx bmad-method install 并选择 Quick Update 以应用更改
检查 YAML 语法是否正确（尤其是缩进）
确认你编辑的是目标智能体对应的 .customize.yaml

智能体无法加载？

使用在线 YAML 验证器检查 YAML 语法错误
确保取消注释后没有遗留空字段
可先回退到模板，再逐项恢复自定义配置

需要重置某个智能体？

清空或删除智能体的 .customize.yaml 文件
运行 npx bmad-method install 并选择 Quick Update 以恢复默认设置

工作流自定义

对现有 BMad Method 工作流和技能的深度自定义能力即将推出。

模块自定义

关于构建扩展模块和自定义现有模块的指南即将推出。

后续步骤

文档分片指南 - 了解如何管理超长文档
命令参考 - 查看可用命令和工作流入口

5.2 KiB Raw Blame History Unescape Escape