ai digest

ai-digest

Ein CLI-Tool zum Zusammenfassen Ihrer Codebasis in einer einzigen Markdown-Datei zur Verwendung mit Claude Projects oder benutzerdefinierten ChatGPTs.

Merkmale

• Fasst alle Dateien im angegebenen Verzeichnis und den Unterverzeichnissen zusammen

• Ignoriert häufige Build-Artefakte und Konfigurationsdateien

• Gibt eine einzelne Markdown-Datei aus, die die gesamte Codebasis enthält

• Bietet Optionen zum Entfernen von Leerzeichen und benutzerdefinierten Ignoriermustern

Verwendung

Führen Sie zunächst das CLI-Tool in Ihrem Projektverzeichnis aus:

 npx ai-digest

Dadurch wird eine codebase.md Datei mit Ihrer Codebasis generiert.

Sobald Sie die Markdown-Datei mit Ihrer Codebasis generiert haben, können Sie sie mit KI-Modellen wie ChatGPT und Claude zur Codeanalyse und Unterstützung verwenden.

Mit ChatGPT:

1. Erstellen Sie ein benutzerdefiniertes GPT

2. Laden Sie die generierte Markdown-Datei in die Wissensdatenbank des GPT hoch

Mit Claude:

1. Erstellen Sie ein neues Projekt

2. Fügen Sie die Markdown-Datei zum Wissen des Projekts hinzu

Um optimale Ergebnisse zu erzielen, laden Sie die Markdown-Datei erneut hoch, bevor Sie eine neue Chat-Sitzung starten, um sicherzustellen, dass die KI über die aktuellste Version Ihrer Codebasis verfügt.

Optionen

• -i, --input <directory> : Eingabeverzeichnis angeben (Standard: aktuelles Verzeichnis)

• -o, --output <file> : Ausgabedatei angeben (Standard: codebase.md)

• --no-default-ignores : Standard-Ignoriermuster deaktivieren

• --whitespace-removal : Aktiviert die Entfernung von Leerzeichen

• --show-output-files : Zeigt eine Liste der in der Ausgabe enthaltenen Dateien an

• --ignore-file <file> : Geben Sie eine benutzerdefinierte Ignorierdatei an (Standard: .aidigestignore)

• --help : Hilfe anzeigen

Beispiele

1. Grundlegende Verwendung:

    npx ai-digest

2. Eingabe und Ausgabe angeben:

    npx ai-digest -i /path/to/your/project -o project_summary.md

3. Aktivieren Sie die Entfernung von Leerzeichen:

    npx ai-digest --whitespace-removal

4. Liste der enthaltenen Dateien anzeigen:

    npx ai-digest --show-output-files

5. Kombinieren Sie mehrere Optionen:

    npx ai-digest -i /path/to/your/project -o project_summary.md --whitespace-removal --show-output-files

Benutzerdefinierte Ignorierungsmuster

ai-digest unterstützt benutzerdefinierte Ignoriermuster mithilfe einer .aidigestignore Datei im Stammverzeichnis Ihres Projekts. Diese Datei funktioniert ähnlich wie .gitignore und ermöglicht Ihnen die Angabe von Dateien und Verzeichnissen, die von der Aggregation ausgeschlossen werden sollen.

Verwenden Sie das Flag --show-output-files um zu sehen, welche Dateien einbezogen werden, und erleichtern Sie so die Identifizierung von Ausschlusskandidaten.

Entfernung von Leerzeichen

Bei Verwendung des Flags --whitespace-removal entfernt ai-digest überschüssige Leerzeichen aus Dateien, um die Tokenanzahl bei Verwendung mit KI-Modellen zu reduzieren. Diese Funktion ist für von Leerzeichen abhängige Sprachen wie Python und YAML deaktiviert.

Handhabung von Binär- und SVG-Dateien

Binärdateien und SVGs werden mit einem Hinweis auf ihren Dateityp in die Ausgabe einbezogen. Dadurch können KI-Modelle diese Dateien erkennen, ohne deren vollständigen Inhalt einzubeziehen.

Lokale Entwicklung

Führen Sie npm run start um das CLI-Tool im lokalen Projekt auszuführen. (Sehr meta!)

Führen Sie npm test aus, um die Tests auszuführen.

Um Flags an die CLI zu übergeben, verwenden Sie das Flag -- wie folgt: npm run start -- --whitespace-removal .

Neue Version bereitstellen

npm publish

Mitwirken

Beiträge sind willkommen! Bitte senden Sie gerne einen Pull Request.

Lizenz

Dieses Projekt ist unter der MIT-Lizenz lizenziert.