scaffold-rules
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseScaffold Rules
脚手架规则
Scaffold shared development rules for AI coding agent environments.
为AI编码Agent环境搭建共享开发规则。
When to Use
使用场景
Use when the user wants to:
- Set up development rules or coding conventions
- Configure their AI coding agent environment
- Add project guidelines for Claude, Cursor, or other agents
当用户需要以下操作时使用:
- 设置开发规则或编码规范
- 配置AI编码Agent环境
- 为Claude、Cursor或其他Agent添加项目指南
Workflow
工作流程
Step 1: Preview Changes (Optional)
步骤1:预览变更(可选)
bash
bunx @plaited/development-skills scaffold-rules --dry-runReview the array to see what will be created.
actionsbash
bunx @plaited/development-skills scaffold-rules --dry-run查看数组以了解将创建的内容。
actionsStep 2: Run Scaffold
步骤2:运行脚手架
bash
bunx @plaited/development-skills scaffold-rulesThis will:
- Copy rules to (canonical location)
.agents/rules/ - Create symlinks in and
.claude/rules(if those directories exist).cursor/rules - Fallback: append links to if no agent directories found
AGENTS.md
bash
bunx @plaited/development-skills scaffold-rules此命令将:
- 将规则复制到(标准存储位置)
.agents/rules/ - 在和
.claude/rules中创建符号链接(如果这些目录存在).cursor/rules - 备选方案:如果未找到Agent目录,则将链接追加到文件中
AGENTS.md
Step 3: Report to User
步骤3:向用户反馈
Tell the user what was created based on the output.
actions根据的输出,告知用户已创建的内容。
actionsCLI Options
CLI选项
| Flag | Description |
|---|---|
| List available rules without scaffolding |
| Preview actions without making changes |
| 标志 | 描述 |
|---|---|
| 列出可用规则而不执行脚手架操作 |
| 预览操作而不进行实际变更 |
How It Works
工作原理
.agents/rules/ ← Canonical location (files copied here)
├── testing.md
├── bun.md
└── ...
.claude/rules -> ../.agents/rules ← Symlink (if .claude/ exists)
.cursor/rules -> ../.agents/rules ← Symlink (if .cursor/ exists)| Project has... | Copy | Symlinks | AGENTS.md |
|---|---|---|---|
| ✓ | None | No |
| ✓ | | No |
| ✓ | | No |
| ✓ | | No |
| ✓ | | No |
| ✓ | Both | No |
| None of the above | ✓ | None | ✓ Append links |
.agents/rules/ ← 标准存储位置(文件复制到此处)
├── testing.md
├── bun.md
└── ...
.claude/rules -> ../.agents/rules ← 符号链接(如果.claude/存在)
.cursor/rules -> ../.agents/rules ← 符号链接(如果.cursor/存在)| 项目包含... | 复制 | 符号链接 | AGENTS.md |
|---|---|---|---|
仅 | ✓ | 无 | 否 |
仅 | ✓ | | 否 |
仅 | ✓ | | 否 |
| ✓ | | 否 |
| ✓ | | 否 |
| ✓ | 两者都有 | 否 |
| 以上都没有 | ✓ | 无 | ✓ 追加链接 |
Related Skills
相关技能
- validate-skill - Validate skill directories against AgentSkills spec
- validate-skill - 针对AgentSkills规范验证技能目录