mcpField
S
scaffold-rules

scaffold-rules

github.com/youdotcom-ossAgent workflows9742 installsUpdated today
Repository

About scaffold-rules

scaffold-rules is a CLI skill for adding shared development rules to AI coding agent environments. It writes managed rules to AGENTS.md and can add an @AGENTS.md reference to an existing CLAUDE.md.

Key features

  1. 01Scaffold rules into AGENTS.md
  2. 02Preserve content outside managed markers
  3. 03Add @AGENTS.md reference to CLAUDE.md
  4. 04List rules and preview changes

Use cases

  1. 01Set up shared project coding conventions
  2. 02Configure guidelines for AI coding agents
  3. 03Preview rule changes before writing files

Install

Copy the command and run it in a terminal.

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

After installing, type/scaffold-rulesin Claude Code to confirm it loaded.

Details

From the project README

Scaffold Rules

Scaffold shared development rules for AI coding agent environments.

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

Workflow

Step 1: Preview Changes (Optional)
bunx @plaited/development-skills scaffold-rules --dry-run

Review the actions array to see what will be created.

Step 2: Run Scaffold
bunx @plaited/development-skills scaffold-rules

This will:

  1. Write rules into AGENTS.md (creates if missing, updates between markers if present)
  2. Add @AGENTS.md reference to CLAUDE.md if it exists without one
Step 3: Report to User

Tell the user what was created based on the actions output.

CLI Options

FlagDescription
--list, -lList available rules without scaffolding
--dry-run, -nPreview actions without making changes

How It Works

Rules are written directly into AGENTS.md between markers:

<!-- PLAITED-RULES-START -->

## Rules

(rule content inlined here)

<!-- PLAITED-RULES-END -->
  • No AGENTS.md: Creates one with rules section
  • AGENTS.md without markers: Appends rules section with markers
  • AGENTS.md with markers: Replaces content between markers (preserves user content outside)
  • CLAUDE.md exists: Adds @AGENTS.md reference if not already present

Troubleshooting

IssueCauseFix
Rules duplicated in AGENTS.mdMarkers were manually deletedRemove duplicate section, re-run scaffold-rules
Update didn't applyOnly one marker present (start or end)Ensure both <!-- PLAITED-RULES-START --> and <!-- PLAITED-RULES-END --> exist, or delete both to get a fresh append
@AGENTS.md not added to CLAUDE.mdCLAUDE.md doesn't existCreate CLAUDE.md first, then re-run

Do not manually edit content between the PLAITED-RULES-START and PLAITED-RULES-END markers — it will be overwritten on next run.

Related Skills

  • validate-skill - Validate skill directories against AgentSkills spec

Comments

Markdown supported