关于 build-workspace-docs
用于在技能目录变更后同步工作区文档的技能，可预览生成内容，并从已初始化的技能库工作区重新生成文档。
主要功能
- 01预览文档变更
- 02重新生成工作区文档
- 03检查文档是否同步
- 04输出结构化 JSON 结果
适用场景
- 01目录整理后更新文档
- 02导入技能后刷新文档
- 03提交变更前验证文档
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/build-workspace-docs确认已加载。
详细介绍
构建工作区文档
目标
添加、移除或整理技能后，确保工作区文档与技能目录保持同步。
注意事项
- 重新生成文档前，始终先使用
--dry-run预览更改。 - 仅在已初始化的库工作区内运行（即包含
.ai-agent-skills/config.json的目录）。 - 切勿手动编辑 README.md 或 WORK_AREAS.md 中由工具生成的部分。CLI 会覆盖这些内容。
- 使用
--format json为自动化流水线捕获结构化结果。
工作流
- 预览将要进行的更改。
npx ai-agent-skills build-docs --dry-run
- 重新生成文档。
npx ai-agent-skills build-docs
- 验证输出。
npx ai-agent-skills build-docs --dry-run --format json
JSON 输出包含 currentlyInSync，用于告知文档是否已是最新状态。
何时运行
- 在更改技能目录的
add、catalog、vendor或curate命令之后。 - 从远程库批量导入之后。
- 将工作区更改提交到 git 之前。
注意事项
- 在工作区外运行会失败，并显示明确的错误。请先使用
init-library创建工作区。 - 生成的文档使用 HTML 注释标记（``）作为边界。请勿从模板部分中移除这些标记。
评论
支持 Markdown