diff --git a/docs/zh-cn/how-to/install-bmad.md b/docs/zh-cn/how-to/install-bmad.md index e0309d2b9..e9fc1af9a 100644 --- a/docs/zh-cn/how-to/install-bmad.md +++ b/docs/zh-cn/how-to/install-bmad.md @@ -5,9 +5,9 @@ sidebar: order: 1 --- -使用 `npx bmad-method install` 命令在项目中设置 BMad，并选择你需要的模块和 AI 工具。 +使用 `npx bmad-method install` 在项目中安装 BMad，并按需选择模块和 AI 工具。 -如果你想使用非交互式安装程序并在命令行中提供所有安装选项，请参阅[本指南](./non-interactive-installation.md)。 +如果你需要在命令行里一次性传入全部安装参数（例如 CI/CD 场景），请阅读[非交互式安装指南](./non-interactive-installation.md)。 ## 何时使用 @@ -29,7 +29,16 @@ sidebar: npx bmad-method install ``` -:::tip[最新版本] +:::tip[想要最新预发布版本？] +使用 `next` 发布标签： +```bash +npx bmad-method@next install +``` + +这会更早拿到新改动，但相比默认安装通道，出现变动的概率也更高。 +::: + +:::tip[前沿版本] 要从主分支安装最新版本（可能不稳定）： ```bash npx github:bmad-code-org/BMAD-METHOD install @@ -51,7 +60,11 @@ npx github:bmad-code-org/BMAD-METHOD install - Cursor - 其他 -每个工具都有自己的命令集成方式。安装程序会创建微小的提示文件来激活工作流和智能体——它只是将它们放在工具期望找到的位置。 +每种工具都有自己的 skills 集成方式。安装程序会生成用于激活工作流和智能体的轻量提示文件，并放到该工具约定的位置。 + +:::note[启用 Skills] +某些平台需要你在设置中手动启用 skills 才会显示。如果你已经安装 BMad 但看不到 skills，请检查平台设置，或直接询问你的 AI 助手如何启用 skills。 +::: ### 4. 选择模块 @@ -63,16 +76,25 @@ npx github:bmad-code-org/BMAD-METHOD install ## 你将获得 +以下目录结构仅作示例。工具相关目录会随你选择的平台变化（例如可能是 +`.claude/skills`、`.cursor/skills` 或 `.kiro/skills`），并不一定会同时出现。 + ```text your-project/ ├── _bmad/ │ ├── bmm/ # 你选择的模块 -│ │ └── config.yaml # 模块设置（如果你需要更改它们） -│ ├── core/ # 必需的核心模块 +│ │ └── config.yaml # 模块设置（后续如需可修改） +│ ├── core/ # 必需核心模块 │ └── ... -├── _bmad-output/ # 生成的工件 -├── .claude/ # Claude Code 命令（如果使用 Claude Code） -└── .kiro/ # Kiro 引导文件（如果使用 Kiro） +├── _bmad-output/ # 生成产物 +├── .claude/ # Claude Code skills（如使用 Claude Code） +│ └── skills/ +│ ├── bmad-help/ +│ ├── bmad-persona/ +│ └── ... +└── .cursor/ # Cursor skills（如使用 Cursor） + └── skills/ + └── ... ``` ## 验证安装 @@ -96,10 +118,3 @@ bmad-help 对于 SaaS 项目我有哪些选项？ **安装程序工作正常但后续出现问题**——你的 AI 需要 BMad 上下文才能提供帮助。请参阅[如何获取关于 BMad 的答案](./get-answers-about-bmad.md)了解如何将你的 AI 指向正确的来源。 ---- -## 术语说明 - -- **agent**：智能体。在人工智能与编程文档中，指具备自主决策或执行能力的单元。 -- **workflow**：工作流。指一系列有序的任务或步骤，用于完成特定目标。 -- **module**：模块。指软件系统中可独立开发、测试和维护的功能单元。 -- **artifact**：工件。指在软件开发过程中生成的任何输出，如文档、代码、配置文件等。 diff --git a/docs/zh-cn/how-to/non-interactive-installation.md b/docs/zh-cn/how-to/non-interactive-installation.md index 930bbe639..fdcfbc9fd 100644 --- a/docs/zh-cn/how-to/non-interactive-installation.md +++ b/docs/zh-cn/how-to/non-interactive-installation.md @@ -1,11 +1,11 @@ --- title: "非交互式安装" -description: 使用命令行标志安装 BMad，适用于 CI/CD 流水线和自动化部署 +description: 使用命令行参数安装 BMad，适用于 CI/CD 流水线和自动化部署 sidebar: order: 2 --- -使用命令行标志以非交互方式安装 BMad。这适用于： +使用命令行参数（flags）以非交互方式安装 BMad。适用于以下场景： ## 使用场景 @@ -18,11 +18,11 @@ sidebar: 需要 [Node.js](https://nodejs.org) v20+ 和 `npx`（随 npm 附带）。 ::: -## 可用标志 +## 可用参数（Flags） ### 安装选项 -| 标志 | 描述 | 示例 | +| 参数 | 描述 | 示例 | |------|-------------|---------| | `--directory ` | 安装目录 | `--directory ~/projects/myapp` | | `--modules ` | 逗号分隔的模块 ID | `--modules bmm,bmb` | @@ -32,7 +32,7 @@ sidebar: ### 核心配置 -| 标志 | 描述 | 默认值 | +| 参数 | 描述 | 默认值 | |------|-------------|---------| | `--user-name ` | 智能体使用的名称 | 系统用户名 | | `--communication-language ` | 智能体通信语言 | 英语 | @@ -41,14 +41,14 @@ sidebar: ### 其他选项 -| 标志 | 描述 | +| 参数 | 描述 | |------|-------------| | `-y, --yes` | 接受所有默认值并跳过提示 | | `-d, --debug` | 启用清单生成的调试输出 | ## 模块 ID -`--modules` 标志可用的模块 ID： +`--modules` 参数可用的模块 ID： - `bmm` — BMad Method Master - `bmb` — BMad Builder @@ -57,7 +57,7 @@ sidebar: ## 工具/IDE ID -`--tools` 标志可用的工具 ID： +`--tools` 参数可用的工具 ID： **推荐：** `claude-code`、`cursor` @@ -67,8 +67,8 @@ sidebar: | 模式 | 描述 | 示例 | |------|-------------|---------| -| 完全非交互式 | 提供所有标志以跳过所有提示 | `npx bmad-method install --directory . --modules bmm --tools claude-code --yes` | -| 半交互式 | 提供部分标志；BMad 提示其余部分 | `npx bmad-method install --directory . --modules bmm` | +| 完全非交互式 | 提供所有参数以跳过所有提示 | `npx bmad-method install --directory . --modules bmm --tools claude-code --yes` | +| 半交互式 | 提供部分参数；BMad 提示其余部分 | `npx bmad-method install --directory . --modules bmm` | | 仅使用默认值 | 使用 `-y` 接受所有默认值 | `npx bmad-method install --yes` | | 不包含工具 | 跳过工具/IDE 配置 | `npx bmad-method install --modules bmm --tools none` | @@ -124,9 +124,9 @@ npx bmad-method install \ - 为所选模块和工具配置的智能体和工作流 - 用于生成产物的 `_bmad-output/` 文件夹 -## 验证和错误处理 +## 参数校验与错误处理 -BMad 会验证所有提供的标志： +BMad 会验证你提供的所有参数： - **目录** — 必须是具有写入权限的有效路径 - **模块** — 对无效的模块 ID 发出警告（但不会失败） @@ -141,14 +141,14 @@ BMad 会验证所有提供的标志： :::tip[最佳实践] - 为 `--directory` 使用绝对路径以避免歧义 -- 在 CI/CD 流水线中使用前先在本地测试标志 +- 在 CI/CD 流水线中使用前先在本地测试参数 - 结合 `-y` 实现真正的无人值守安装 - 如果在安装过程中遇到问题，使用 `--debug` ::: ## 故障排除 -### 安装失败，提示"Invalid directory" +### 安装失败，提示 `Invalid directory` - 目录路径必须存在（或其父目录必须存在） - 您需要写入权限 @@ -167,15 +167,6 @@ BMad 会验证所有提供的标志： - 在 `module.yaml` 中有 `code` 字段 :::note[仍然卡住了？] -使用 `--debug` 运行以获取详细输出，尝试交互模式以隔离问题，或在 报告。 +使用 `--debug` 获取详细输出，尝试交互模式定位问题，或在 提交反馈。 ::: ---- -## 术语说明 - -- **CI/CD**：持续集成/持续部署。一种自动化软件开发流程的实践，用于频繁集成代码更改并自动部署到生产环境。 -- **agent**：智能体。在人工智能与编程文档中，指具备自主决策或执行能力的单元。 -- **module**：模块。软件系统中可独立开发、测试和维护的功能单元。 -- **IDE**：集成开发环境。提供代码编辑、调试、构建等功能的软件开发工具。 -- **npx**：Node Package eXecute。npm 包执行器，用于直接执行 npm 包而无需全局安装。 -- **workflow**：工作流。一系列有序的任务或步骤，用于完成特定的业务流程或开发流程。