scaffold-rules

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Scaffold 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-run
Review the
actions
array to see what will be created.
bash
bunx @plaited/development-skills scaffold-rules --dry-run
查看
actions
数组以了解将创建的内容。

Step 2: Run Scaffold

步骤2:运行脚手架

bash
bunx @plaited/development-skills scaffold-rules
This will:
  1. Copy rules to
    .agents/rules/
    (canonical location)
  2. Create symlinks in
    .claude/rules
    and
    .cursor/rules
    (if those directories exist)
  3. Fallback: append links to
    AGENTS.md
    if no agent directories found
bash
bunx @plaited/development-skills scaffold-rules
此命令将:
  1. 将规则复制到
    .agents/rules/
    (标准存储位置)
  2. .claude/rules
    .cursor/rules
    中创建符号链接(如果这些目录存在)
  3. 备选方案:如果未找到Agent目录,则将链接追加到
    AGENTS.md
    文件中

Step 3: Report to User

步骤3:向用户反馈

Tell the user what was created based on the
actions
output.
根据
actions
的输出,告知用户已创建的内容。

CLI Options

CLI选项

FlagDescription
--list
,
-l
List available rules without scaffolding
--dry-run
,
-n
Preview actions without making changes
标志描述
--list
,
-l
列出可用规则而不执行脚手架操作
--dry-run
,
-n
预览操作而不进行实际变更

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...CopySymlinksAGENTS.md
.agents/
only
NoneNo
.claude/
only
.claude/rules
No
.cursor/
only
.cursor/rules
No
.agents/
+
.claude/
.claude/rules
No
.agents/
+
.cursor/
.cursor/rules
No
.agents/
+
.claude/
+
.cursor/
BothNo
None of the aboveNone✓ Append links
.agents/rules/          ← 标准存储位置(文件复制到此处)
    ├── testing.md
    ├── bun.md
    └── ...

.claude/rules -> ../.agents/rules   ← 符号链接(如果.claude/存在)
.cursor/rules -> ../.agents/rules   ← 符号链接(如果.cursor/存在)
项目包含...复制符号链接AGENTS.md
.agents/
.claude/
.claude/rules
.cursor/
.cursor/rules
.agents/
+
.claude/
.claude/rules
.agents/
+
.cursor/
.cursor/rules
.agents/
+
.claude/
+
.cursor/
两者都有
以上都没有✓ 追加链接

Related Skills

相关技能

  • validate-skill - Validate skill directories against AgentSkills spec
  • validate-skill - 针对AgentSkills规范验证技能目录