用途
scaffold-rules 用于为 AI 编程代理环境搭建共享的开发规则。当用户希望设置开发规则或编码约定、配置其 AI 编码代理环境,或为 Claude、Cursor 等代理添加项目指南时,可使用该工具。
主要能力
- 将规则写入 AGENTS.md:文件缺失时创建,存在且在标记之间时更新标记内的内容。
- 为 CLAUDE.md 添加 @AGENTS.md 引用(前提是 CLAUDE.md 已存在且尚未包含该引用)。
- 支持预览与列表:通过 --dry-run / -n 预览将执行的操作而不实际修改;通过 --list / -l 列出可用规则而不进行搭建。
使用方式
工作流程分为三步:
-
预览更改(可选):
bunx @plaited/development-skills scaffold-rules --dry-run
查看 actions 数组以了解将要创建的内容。
-
运行搭建:
bunx @plaited/development-skills scaffold-rules
该命令会:
- 将规则写入 AGENTS.md(缺失时创建,存在时更新标记之间的内容)
- 若 CLAUDE.md 存在且没有 @AGENTS.md 引用,则添加该引用
-
向用户报告:根据 actions 输出告知用户创建了什么。
CLI 选项:
| 标志 | 说明 |
|---|---|
| --list, -l | 列出可用规则,不进行搭建 |
| --dry-run, -n | 预览将执行的操作,不作出更改 |
工作原理
规则直接写入 AGENTS.md 中标记之间的位置:
<!-- PLAITED-RULES-START -->
Rules
(规则内容内联在此处)
<!-- PLAITED-RULES-END -->
针对不同文件状态的行为:
- 没有 AGENTS.md:创建一个并包含规则章节
- AGENTS.md 没有标记:追加带标记的规则章节
- AGENTS.md 已有标记:替换标记之间的内容(保留标记之外的用户内容)
- CLAUDE.md 存在:若尚未包含,则添加 @AGENTS.md 引用
限制与注意事项
- 请勿手动编辑 PLAITED-RULES-START 与 PLAITED-RULES-END 标记之间的内容,因为下次运行时会将其覆盖。
常见问题与处理:
| 问题 | 原因 | 修复方式 |
|---|---|---|
| AGENTS.md 中规则重复 | 标记被手动删除 | 删除重复章节,重新运行 scaffold-rules |
| 更新未生效 | 只存在一个标记(开始或结束) | 确保 <!-- PLAITED-RULES-START --> 和 <!-- PLAITED-RULES-END --> 同时存在,或同时删除两者以进行全新追加 |
| CLAUDE.md 未添加 @AGENTS.md | CLAUDE.md 不存在 | 先创建 CLAUDE.md,然后重新运行 |
相关技能
validate-skill —— 依据 AgentSkills 规范校验技能目录。
产品价格、平台支持范围等更多信息暂未提供。