scaffold-rules について
scaffold-rulesは、AIコーディングエージェント環境に共通の開発ルールを追加するCLIスキルです。ルールをAGENTS.mdに書き込み、既存のCLAUDE.mdには@AGENTS.mdの参照を追加できます。
主な機能
- 01AGENTS.mdへのルール追加
- 02管理マーカー外の内容を保持
- 03CLAUDE.mdへの@AGENTS.md参照追加
- 04ルール一覧と変更のプレビュー
活用シーン
- 01共有プロジェクトのコーディング規約を設定
- 02AIコーディングエージェントのガイドラインを構成
- 03ファイル変更前にルールをプレビュー
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ youdotcom-oss/ agent-skills --skill scaffold-rulesインストール後、Claude Code で/scaffold-rulesを入力して読み込まれたか確認します。
詳細
ルールのスキャフォールド
AI コーディングエージェント環境向けに、共通の開発ルールをスキャフォールドします。
使用するタイミング
次のことをユーザーが希望している場合に使用します。
- 開発ルールやコーディング規約を設定する
- AI コーディングエージェント環境を構成する
- Claude、Cursor、その他のエージェント向けにプロジェクトガイドラインを追加する
ワークフロー
ステップ 1:変更をプレビューする(任意)
bunx @plaited/development-skills scaffold-rules --dry-run
actions 配列を確認し、何が作成されるかを確認します。
ステップ 2:スキャフォールドを実行する
bunx @plaited/development-skills scaffold-rules
次の処理が行われます。
- ルールを
AGENTS.mdに書き込みます(ファイルが存在しない場合は作成し、存在する場合はマーカー間を更新します) 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 を再実行します |
| 更新が反映されなかった | マーカーが片方(開始または終了)しかない | と の両方があることを確認するか、両方を削除して新たに追記します |
@AGENTS.md が CLAUDE.md に追加されない | CLAUDE.md が存在しない | まず CLAUDE.md を作成してから、再実行します |
PLAITED-RULES-START と PLAITED-RULES-END のマーカー間にある内容を手動で編集しないでください。次回の実行時に上書きされます。
関連スキル
- validate-skill - AgentSkills 仕様に照らしてスキルディレクトリを検証します
コメント
Markdown 対応