Was macht project-indexer?
Plattformunabhängige KI-Agenten-Fähigkeit: Indiziert ein Projekt in PROJECT_INDEX.md mit detaillierten Dateibeschreibungen und integriert es in CLAUDE.md, AGENTS.md, Cursor-Regeln, Windsurf-Regeln, Copilot-Anweisungen usw.
Nutzen
Diese Fähigkeit hilft KI-Assistenten, die Projektstruktur schnell zu verstehen, indem sie einen zentralen Index mit einer Beschreibung jeder Datei bereitstellt. Dies reduziert die Zeit, die benötigt wird, um sich in einer neuen oder komplexen Codebasis zurechtzufinden, und stellt sicher, dass Agenten relevante Dateien für Aufgaben finden können.
Funktionsweise
- Scannen: Der Skill durchsucht das gesamte Projektverzeichnis nach Dateien, überspringt dabei typische Ignorierpfade (z. B.
node_modules,.git,build). - Analysieren: Jede Datei wird untersucht, um ihren Zweck zu bestimmen (z. B. basierend auf Dateiname, Erweiterung und Inhalt).
- Generieren: Es wird eine
PROJECT_INDEX.md-Datei erstellt, die jede Datei mit einer prägnanten Beschreibung auflistet. - Integrieren: Der Skill fügt entsprechende Verweise in die Konfigurationsdateien der unterstützten Plattformen ein, sodass der Index für jeden Assistenten leicht zugänglich ist.
Unterstützte Plattformen
| Plattform | Konfigurationsdatei(en) |
|---|---|
| Claude Code | CLAUDE.md |
| Allgemeine Agenten | AGENTS.md |
| Cursor | .cursor/rules/ |
| Windsurf | .windsurf/rules/ |
| Copilot | .github/copilot-instructions.md |
Verwendung
Füge diesen Skill deiner KI-Agenten-Konfiguration hinzu. Der Skill führt den Indizierungsprozess automatisch aus, wenn er aktiviert wird. Du kannst die Indizierung auch manuell auslösen, indem du den folgenden Befehl ausführst:
npx pccly/project-indexer
Oder führe ihn über einen Task in deiner Konfigurationsdatei aus, z. B.:
claude.md
- **Task: Projekt indizieren**: Führe `npx pccly/project-indexer` aus, um die `PROJECT_INDEX.md` zu generieren/aktualisieren.
Konfiguration
Der Skill verwendet standardmäßig sinnvolle Einstellungen, kann aber über Umgebungsvariablen angepasst werden:
PROJECT_INDEXER_IGNORE: Eine kommagetrennte Liste von Verzeichnissen oder Dateimustern, die beim Scannen ignoriert werden sollen (z. B.dist,*.log).PROJECT_INDEXER_OUTPUT: Der Pfad zur Ausgabedatei (Standard:./PROJECT_INDEX.md).PROJECT_INDEXER_DEPTH: Maximale Suchtiefe im Verzeichnisbaum (Standard:10).
Hinweise
- Stelle sicher, dass die
PROJECT_INDEX.md-Datei in deiner.gitignoreenthalten ist, wenn du sie nicht versionieren möchtest. - Der Skill überschreibt vorhandene Indexdateien nicht ohne Aufforderung; er fragt nach Bestätigung, falls eine Datei bereits existiert.
Lizenz
MIT