build-workspace-docs について
スキルカタログの変更後に、ワークスペースのドキュメントを同期するスキルです。生成内容を事前確認し、初期化済みのライブラリワークスペースでドキュメントを再生成します。
主な機能
- 01ドキュメント変更のプレビュー
- 02ワークスペース文書の再生成
- 03文書の同期状態を確認
- 04構造化 JSON 結果の出力
活用シーン
- 01カタログ整理後の文書更新
- 02スキルのインポート後に文書を更新
- 03変更のコミット前に文書を検証
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/インストール後、Claude Code で/build-workspace-docsを入力して読み込まれたか確認します。
詳細
ワークスペースのドキュメントを生成する
目的
スキルカタログの追加、削除、整理を行った後に、ワークスペースのドキュメントをスキルカタログと同期させます。
注意事項
- ドキュメントを再生成する前に、必ず
--dry-runを使用して変更内容を確認してください。 - 初期化済みのライブラリワークスペース（
.ai-agent-skills/config.jsonがあるディレクトリ）内からのみ実行してください。 - README.md または WORK_AREAS.md の生成されたセクションを手動で編集しないでください。CLI によって上書きされます。
- 自動化パイプラインで構造化された結果を取得するには、
--format jsonを使用してください。
ワークフロー
- 変更内容をプレビューします。
npx ai-agent-skills build-docs --dry-run
- ドキュメントを再生成します。
npx ai-agent-skills build-docs
- 出力を確認します。
npx ai-agent-skills build-docs --dry-run --format json
JSON 出力には currentlyInSync が含まれており、ドキュメントがすでに最新の状態かどうかを確認できます。
実行するタイミング
- スキルカタログを変更する
add、catalog、vendor、curateコマンドの実行後。 - リモートライブラリから一括インポートした後。
- ワークスペースの変更を git にコミットする前。
注意点
- ワークスペースの外で実行すると、明確なエラーが表示されて失敗します。まず
init-libraryを使用してワークスペースを作成してください。 - 生成されるドキュメントでは、HTML コメントマーカー（``）を境界として使用します。テンプレートセクションからこれらのマーカーを削除しないでください。
コメント
Markdown 対応