SuperAPI AI 工具集

scaffold-rules

智能体与模型

查看项目

更新于 10-16 08:06

技能介绍

用途:为 AI 编码代理环境搭建共享开发规则,适用于设置开发规则或编码约定、配置 AI 编码代理环境、为 Claude、Cursor 等代理添加项目指南的场景。

主要能力:将规则写入 AGENTS.md(缺失时创建,已存在时在标记之间更新);若 CLAUDE.md 存在且尚无引用,则向其添加 @AGENTS.md 引用;支持仅列出可用规则或预览变更。

使用方式:

  1. 可选预览:bunx @plaited/development-skills scaffold-rules --dry-run,查看 actions 数组了解将创建的内容。
  2. 运行:bunx @plaited/development-skills scaffold-rules。
  3. 根据 actions 输出向用户报告创建了什么。 CLI 选项:--list、-l 仅列出可用规则;--dry-run、-n 预览操作而不做更改。

规则写入逻辑:规则直接写在 AGENTS.md 的 <!-- PLAITED-RULES-START --> 与 <!-- PLAITED-RULES-END --> 标记之间。无 AGENTS.md 时创建带规则区的新文件;无标记时追加带标记的规则区;有标记时替换标记间内容并保留标记外用户内容。CLAUDE.md 存在时补充 @AGENTS.md 引用。

限制与注意事项:不要手动编辑两个标记之间的内容,下次运行会覆盖。排障:AGENTS.md 规则重复通常因标记被手动删除,删除重复段后重跑;更新未生效多因只存在一个标记,需确保起止标记都存在,或两者都删除以重新追加;@AGENTS.md 未加入 CLAUDE.md 通常是 CLAUDE.md 不存在,先创建再重跑。

相关技能:validate-skill,用于按 AgentSkills 规范校验技能目录。其余细节资料暂未提供。