Communityコーディング&開発github.com

ddasy/claude-md-index-skill

Claude Code スキル: コードベースに階層型 Markdown インデックスを構築します — INDEX.md + ディレクトリごとの README + CLAUDE.md ルールにより、Claude がコンテキストを浪費せずにコードを高速に特定できるようになります。

claude-md-index-skill とは?

このスキルは、Claude Code エージェントが大規模コードベースを効率的にナビゲートできるようにするための、階層型 Markdown インデックスを自動生成します。プロジェクトルートに INDEX.md、各サブディレクトリに README.md、そして Claude の振る舞いをガイドする CLAUDE.md ルールを作成することで、エージェントがファイルシステムをスキャンする代わりにインデックスを参照して目的のコードを迅速に特定できるようにします。これにより、コンテキストウィンドウの消費を最小限に抑え、開発効率が向上します。Claude Code 専用に設計されており、他の AI エージェント(Cursor や Codex など)でも同様の構造を活用できます。スキルを実行すると、指定されたルートディレクトリを再帰的にスキャンし、各ディレクトリの内容を要約したマークダウンファイルを生成します。生成されたインデックスは、Claude がコードの場所を推測する必要をなくし、正確なファイルパスを直接提供します。

対応✓Claude Code~Codex CLI~Cursor
npx skills add ddasy/claude-md-index-skill

Installed? Explore more コーディング&開発 skills: steipete/bluebubbles, steipete/eightctl, steipete/blucli · View all 6 →

お気に入りのAIに質問する

このエージェントスキルを事前に読み込んだ状態で新しいチャットを開きます。

ドキュメント

claude-md-index-skill は何をしますか?

Claude Code スキル: コードベースに階層型 Markdown インデックスを構築します — INDEX.md + ディレクトリごとの README + CLAUDE.md ルールにより、Claude がコンテキストを浪費せずにコードを高速に特定できるようになります。

概要

このスキルは、コードベースの構造を理解し、Claude Code(および他の AI エージェント)がコードを効率的にナビゲートできるようにするための、読み取り可能な Markdown インデックスを生成します。

仕組み

  1. プロジェクトルートに INDEX.md を生成します。これにはコードベース全体のトップレベルの要約と、各ディレクトリへのリンクが含まれます。
  2. 各ディレクトリに README.md を生成します。各ディレクトリの目的、主要なファイル、サブディレクトリを説明します。
  3. CLAUDE.md (または類似のルールファイル)を生成または更新し、Claude にこれらのインデックスファイルを参照するよう指示します。

使用方法

  1. このリポジトリを複製するか、スキルファイルを Claude Code のプロジェクトにコピーします。

  2. ターミナルで Claude Code を開き、以下のコマンドを実行します。

    claude "このプロジェクトの INDEX.md を生成してください"
    
  3. Claude がコードベースをスキャンし、階層型インデックスを構築します。

利点

  • コンテキストの節約: Claude はインデックスを読むだけでコードの場所を特定できるため、ファイルシステム全体をスキャンする必要がありません。
  • 高速なナビゲーション: インデックスにより、Claude は目的のコードに直接ジャンプできます。
  • 一貫性: すべてのプロジェクトで標準化された構造が維持されます。

対応プラットフォーム

  • Claude Code: 主要ターゲット。
  • Cursor: 同様のルールファイルを使用して適応可能。
  • Codex: プロンプトにインデックスパスを追加することで使用可能。

ライセンス

MIT

関連スキル