ddasy/claude-md-index-skill

Was macht claude-md-index-skill?

Claude Code-Fähigkeit: Starten Sie ein mehrstufiges Markdown-Indexsystem für Ihre Codebasis – INDEX.md + verzeichnisweise READMEs + CLAUDE.md-Regeln, damit Claude schnell Code findet, ohne Kontext zu verbrauchen.

Übersicht

Diese Fähigkeit generiert automatisch eine INDEX.md-Datei mit einer Übersicht über die Projektstruktur, verzeichnisweise README.md-Dateien mit detaillierten Beschreibungen der Module und CLAUDE.md-Regeln, die Claude anweisen, den generierten Index zu verwenden.

Funktionsweise

1. Analyse der Verzeichnisstruktur: Der Skill durchläuft das Projektverzeichnis rekursiv und identifiziert die wichtigsten Komponenten.
2. Extraktion von Metadaten: Er extrahiert Schlüsselinformationen aus Dateien wie Abhängigkeiten (imports), Exporte, Tests (test files) und Dokumentation.
3. Generierung des Index: Er erstellt eine hierarchische INDEX.md-Datei mit Links zu den wichtigsten Verzeichnissen und Dateien.
4. Erstellung von READMEs: Für jedes Verzeichnis wird eine README.md erstellt, die die enthaltenen Dateien und deren Zweck beschreibt.
5. Konfiguration von CLAUDE.md: Eine CLAUDE.md-Datei wird erstellt oder aktualisiert, die Claude anweist, den Index zu verwenden, bevor Code analysiert wird.

Vorteile

• Reduzierter Kontextverbrauch: Claude muss nicht das gesamte Projekt durchsuchen, sondern kann den Index effizient nutzen.
• Schnellere Navigation: Claude findet relevanten Code schneller, insbesondere in großen Codebasen.
• Bessere Struktur: Die generierten READMEs verbessern die Lesbarkeit und das Verständnis des Projekts.
• Automatisierung: Keine manuelle Pflege des Index erforderlich – der Skill aktualisiert ihn bei Bedarf.

Verwendung

Führen Sie den Skill in Ihrem Projektverzeichnis aus:

claude code --skill ddasy/claude-md-index-skill

Der Skill erstellt oder aktualisiert dann die folgenden Dateien:

• INDEX.md – Projektweiter Index
• README.md in jedem Verzeichnis (optional)
• CLAUDE.md – Regeln für Claude

Voraussetzungen

• Claude Code (CLI oder VS Code-Erweiterung)
• Zugriff auf das Dateisystem (lokal oder remote)
• tree- und grep-Befehle sollten verfügbar sein (Standard auf den meisten Systemen)

Konfiguration

Der Skill respektiert folgende Umgebungsvariablen (optional):

• SKIP_DIRS – Durch Kommas getrennte Liste von Verzeichnissen, die übersprungen werden sollen (z. B. node_modules,.git,build)
• MAX_DEPTH – Maximale Tiefe der Verzeichnisanalyse (Standard: 5)
• OUTPUT_FILE – Name der Indexdatei (Standard: INDEX.md)

Beispiel

Angenommen, Ihr Projekt hat folgende Struktur:

projekt/
├── src/
│   ├── utils/
│   │   ├── helpers.js
│   │   └── constants.js
│   └── main.js
└── tests/
    └── main.test.js

Nach der Ausführung des Skills wird eine INDEX.md erstellt mit:

# Projekt-Index

## src/
- `src/main.js` – Einstiegspunkt der Anwendung
- `src/utils/` – Hilfsfunktionen und Konstanten
  - `src/utils/helpers.js` – Allgemeine Hilfsfunktionen
  - `src/utils/constants.js` – Anwendungskonstanten

## tests/
- `tests/main.test.js` – Tests für die Hauptlogik

Lizenz

MIT