mcpField
S
scaffold-rules

scaffold-rules

github.com/youdotcom-ossAgent 工作流9742 次安装今天更新
代码仓库

关于 scaffold-rules

scaffold-rules 是用于在 AI 编码 Agent 环境中添加共享开发规则的 CLI 技能。它将规则写入 AGENTS.md，并可在已有的 CLAUDE.md 中添加 @AGENTS.md 引用。

主要功能

  1. 01将规则写入 AGENTS.md
  2. 02保留管理标记外的内容
  3. 03向 CLAUDE.md 添加 @AGENTS.md 引用
  4. 04列出规则并预览变更

适用场景

  1. 01设置共享的项目编码规范
  2. 02配置 AI 编码 Agent 指南
  3. 03写入文件前预览规则变更

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/youdotcom-oss/agent-skills --skill scaffold-rules

安装后在 Claude Code 中输入/scaffold-rules确认已加载。

详细介绍

脚手架规则

为 AI 编码 Agent 环境搭建共享开发规则。

适用场景

当用户希望：

  • 设置开发规则或编码约定
  • 配置 AI 编码 Agent 环境
  • 为 Claude、Cursor 或其他 Agent 添加项目指南

工作流

步骤 1：预览更改（可选）
bunx @plaited/development-skills scaffold-rules --dry-run

查看 actions 数组，了解将创建的内容。

步骤 2：运行脚手架
bunx @plaited/development-skills scaffold-rules

此操作将：

  1. 将规则写入 AGENTS.md（如果文件不存在则创建；如果存在标记，则更新标记之间的内容）
  2. 如果 CLAUDE.md 存在但尚无引用，则添加 @AGENTS.md 引用
步骤 3：向用户报告

根据 actions 输出告知用户创建了哪些内容。

CLI 选项

标志说明
--list、-l列出可用规则，不搭建脚手架
--dry-run、-n预览操作，不进行更改

工作原理

规则会直接写入 AGENTS.md 中的标记之间：



## Rules

(rule content inlined here)
  • 没有 AGENTS.md：创建文件并添加规则部分
  • AGENTS.md 中没有标记：追加带有标记的规则部分
  • AGENTS.md 中有标记：替换标记之间的内容（保留标记之外的用户内容）
  • 存在 CLAUDE.md：如果尚未添加，则添加 @AGENTS.md 引用

故障排除

问题原因修复方法
AGENTS.md 中的规则重复标记被手动删除删除重复部分，然后重新运行 scaffold-rules
更新未生效仅存在一个标记（开始或结束）确保 和 都存在，或删除两者以重新追加
未向 CLAUDE.md 添加 @AGENTS.mdCLAUDE.md 不存在先创建 CLAUDE.md，然后重新运行

不要手动编辑 PLAITED-RULES-START 和 PLAITED-RULES-END 标记之间的内容——下次运行时会被覆盖。

相关技能

  • validate-skill - 根据 AgentSkills 规范验证技能目录

评论

支持 Markdown