Repomix

Warp, das Agententerminal für Entwickler

Verfügbar für MacOS, Linux und Windows

📦 Repomix ist ein leistungsstarkes Tool, das Ihr gesamtes Repository in eine einzige, KI-freundliche Datei packt.
Es ist perfekt, wenn Sie Ihre Codebasis in Large Language Models (LLMs) oder andere KI-Tools wie Claude, ChatGPT, DeepSeek, Perplexity, Gemini, Gemma, Llama, Grok und mehr einspeisen müssen.

🎉 Neu: Repomix-Website und Discord-Community!

• Probieren Sie Repomix in Ihrem Browser unter repomix.com aus
• Treten Sie unserem Discord-Server für Support und Diskussionen bei

Wir freuen uns auf Ihren Besuch!

🌟 Funktionen

• KI-optimiert : Formatiert Ihre Codebasis so, dass sie für die KI leicht zu verstehen und zu verarbeiten ist.
• Token-Zählung : Bietet Token-Zählungen für jede Datei und das gesamte Repository, nützlich für LLM-Kontextgrenzen.
• Einfach zu verwenden : Sie benötigen nur einen Befehl, um Ihr gesamtes Repository zu packen.
• Anpassbar : Konfigurieren Sie einfach, was ein- oder ausgeschlossen werden soll.
• Git-Aware : Respektiert automatisch Ihre .gitignore Dateien und .git/info/exclude .
• Auf Sicherheit ausgerichtet : Enthält Secretlint für robuste Sicherheitsprüfungen, um die Aufnahme vertraulicher Informationen zu erkennen und zu verhindern.
• Codekomprimierung : Die Option --compress verwendet Tree-Sitter, um wichtige Codeelemente zu extrahieren und so die Tokenanzahl zu reduzieren, während die Struktur erhalten bleibt.

🚀 Schnellstart

Verwenden des CLI-Tools >_

Sie können Repomix sofort in Ihrem Projektverzeichnis ausprobieren, ohne es installieren zu müssen:

Oder global installieren für wiederholte Verwendung:

Das war's! Repomix generiert eine repomix-output.xml Datei in Ihrem aktuellen Verzeichnis, die Ihr gesamtes Repository in einem AI-freundlichen Format enthält.

Sie können diese Datei dann mit einer Eingabeaufforderung wie der folgenden an einen KI-Assistenten senden:

Wenn Sie spezifische Änderungen vorschlagen, kann die KI möglicherweise entsprechenden Code generieren. Mit Funktionen wie Claude's Artifacts können Sie potenziell mehrere Dateien ausgeben und so mehrere voneinander abhängige Codeteile generieren.

Viel Spaß beim Programmieren! 🚀

Nutzung der Website 🌐

Möchten Sie es schnell ausprobieren? Besuchen Sie die offizielle Website unter repomix.com . Geben Sie einfach Ihren Repository-Namen und optionale Details ein und klicken Sie auf die Schaltfläche „Packen“ , um die generierte Ausgabe anzuzeigen.

Verfügbare Optionen

Die Website bietet mehrere praktische Funktionen:

• Anpassbares Ausgabeformat (XML, Markdown oder einfacher Text)
• Sofortige Schätzung der Tokenanzahl
• Viel mehr!

Verwenden der Browsererweiterung 🧩

Erhalten Sie sofortigen Zugriff auf Repomix direkt aus jedem GitHub-Repository! Unsere Chrome-Erweiterung fügt den GitHub-Repository-Seiten einen praktischen „Repomix“-Button hinzu.

Installieren

• Chrome-Erweiterung: Repomix – Chrome Web Store
• Firefox-Add-on: Demnächst verfügbar

Merkmale

• Ein-Klick-Zugriff auf Repomix für jedes GitHub-Repository
• Weitere spannende Funktionen folgen in Kürze!

Verwenden der VSCode-Erweiterung ⚡️

Mit der von der Community gepflegten VSCode-Erweiterung Repomix Runner (erstellt von massdo ) können Sie Repomix mit nur wenigen Klicks direkt in Ihrem Editor ausführen. Führen Sie es in jedem Ordner aus, verwalten Sie Ausgaben nahtlos und steuern Sie alles über die intuitive Benutzeroberfläche von VSCode.

Möchten Sie Ihre Ausgabe als Datei oder nur den Inhalt? Benötigen Sie eine automatische Bereinigung? Diese Erweiterung bietet Ihnen die Lösung. Außerdem funktioniert sie reibungslos mit Ihrer vorhandenen repomix.config.json.

Probieren Sie es jetzt im VSCode Marketplace aus! Der Quellcode ist auf GitHub verfügbar.

Alternative Werkzeuge 🛠️

Wenn Sie Python verwenden, sollten Sie sich Gitingest ansehen, das besser für das Python-Ökosystem und Data-Science-Workflows geeignet ist: https://github.com/cyclotruc/gitingest

📊 Verwendung

So packen Sie Ihr gesamtes Repository:

So packen Sie ein bestimmtes Verzeichnis:

So packen Sie bestimmte Dateien oder Verzeichnisse mithilfe von Glob-Mustern :

So schließen Sie bestimmte Dateien oder Verzeichnisse aus:

So packen Sie ein Remote-Repository:

So komprimieren Sie die Ausgabe:

So initialisieren Sie eine neue Konfigurationsdatei ( repomix.config.json ):

Sobald Sie die gepackte Datei generiert haben, können Sie sie mit generativen KI-Tools wie ChatGPT, DeepSeek, Perplexity, Gemini, Gemma, Llama, Grok und mehr verwenden.

Docker-Nutzung 🐳

Sie können Repomix auch mit Docker ausführen.
Dies ist nützlich, wenn Sie Repomix in einer isolierten Umgebung ausführen möchten oder lieber Container verwenden.

Grundlegende Verwendung (aktuelles Verzeichnis):

So packen Sie ein bestimmtes Verzeichnis:

Verarbeiten Sie ein Remote-Repository und geben Sie es in ein output aus:

Beispiele für Eingabeaufforderungen

Sobald Sie die gepackte Datei mit Repomix erstellt haben, können Sie sie mit KI-Tools wie ChatGPT, DeepSeek, Perplexity, Gemini, Gemma, Llama, Grok und anderen verwenden. Hier sind einige Beispieleingabeaufforderungen für den Einstieg:

Codeüberprüfung und Refactoring

Für eine umfassende Codeüberprüfung und Refactoring-Vorschläge:

Dokumentationserstellung

So erstellen Sie eine Projektdokumentation:

Testfallgenerierung

Zum Generieren von Testfällen:

Bewertung der Codequalität

Bewerten Sie die Codequalität und die Einhaltung bewährter Methoden:

Bibliotheksübersicht

Verschaffen Sie sich einen umfassenden Überblick über die Bibliothek

Sie können diese Eingabeaufforderungen gerne an Ihre spezifischen Anforderungen und die Funktionen des von Ihnen verwendeten KI-Tools anpassen.

Community-Diskussion

Schauen Sie sich unsere Community-Diskussion an, in der Benutzer Folgendes teilen:

• Welche KI-Tools sie mit Repomix verwenden
• Wirksame Aufforderungen, die sie entdeckt haben
• Wie Repomix ihnen geholfen hat
• Tipps und Tricks, um das Beste aus der KI-Codeanalyse herauszuholen

Beteiligen Sie sich gerne an der Diskussion und teilen Sie Ihre eigenen Erfahrungen! Ihre Erkenntnisse können anderen helfen, Repomix besser zu nutzen.

Ausgabedateiformat

Repomix generiert eine einzelne Datei mit klaren Trennzeichen zwischen den verschiedenen Teilen Ihrer Codebasis.
Um das Verständnis der KI zu verbessern, beginnt die Ausgabedatei mit einer KI-orientierten Erklärung, die es KI-Modellen erleichtert, den Kontext und die Struktur des gepackten Repositorys zu verstehen.

XML-Format (Standard)

Das XML-Format strukturiert den Inhalt hierarchisch:

Für alle, die sich für das Potenzial von XML-Tags im KI-Kontext interessieren:
https://docs.anthropic.com/en/docs/build-with-claude/prompt-engineering/use-xml-tags

Wenn Ihre Eingabeaufforderungen mehrere Komponenten wie Kontext, Anweisungen und Beispiele umfassen, können XML-Tags entscheidend sein. Sie helfen Claude, Ihre Eingabeaufforderungen genauer zu analysieren, was zu qualitativ hochwertigeren Ergebnissen führt.

Dies bedeutet, dass die XML-Ausgabe von Repomix nicht nur ein anderes Format ist, sondern möglicherweise eine effektivere Möglichkeit darstellt, Ihre Codebasis zur Analyse, Codeüberprüfung oder für andere Aufgaben in KI-Systeme einzuspeisen.

Markdown-Format

Um eine Ausgabe im Markdown-Format zu generieren, verwenden Sie die Option --style markdown :

Das Markdown-Format strukturiert den Inhalt hierarchisch:

Dieses Format bietet eine saubere, lesbare Struktur, die sowohl benutzerfreundlich als auch für KI-Systeme leicht zu analysieren ist.

Nur-Text-Format

Um eine Ausgabe im Nur-Text-Format zu generieren, verwenden Sie die Option --style plain :

Befehlszeilenoptionen

Grundlegende Optionen

• -v, --version : Tool-Version anzeigen

Ausgabeoptionen

• -o, --output <file> : Geben Sie den Namen der Ausgabedatei an
• --stdout : Ausgabe an stdout statt in eine Datei zu schreiben (kann nicht mit der Option --output verwendet werden)
• --style <style> : Geben Sie den Ausgabestil an ( xml , markdown , plain )
• --parsable-style : Aktiviert die analysierbare Ausgabe basierend auf dem gewählten Stilschema. Beachten Sie, dass dies die Tokenanzahl erhöhen kann.
• --compress : Führen Sie eine intelligente Codeextraktion durch und konzentrieren Sie sich dabei auf wesentliche Funktions- und Klassensignaturen, um die Anzahl der Token zu reduzieren.
• --output-show-line-numbers : Zeilennummern in der Ausgabe anzeigen
• --copy : Kopiert die generierte Ausgabe zusätzlich in die Systemzwischenablage
• --no-file-summary : Ausgabe des Abschnitts „Dateizusammenfassung“ deaktivieren
• --no-directory-structure : Ausgabe des Abschnitts „Verzeichnisstruktur“ deaktivieren
• --remove-comments : Entfernt Kommentare aus unterstützten Dateitypen
• --remove-empty-lines : Entfernt leere Zeilen aus der Ausgabe
• --header-text <text> : Benutzerdefinierter Text, der in den Dateikopf aufgenommen werden soll
• --instruction-file-path <path> : Pfad zu einer Datei mit detaillierten benutzerdefinierten Anweisungen
• --include-empty-directories : Leere Verzeichnisse in die Ausgabe einschließen
• --include-diffs : Git-Diffs in die Ausgabe einschließen (schließt sowohl Arbeitsbaum als auch inszenierte Änderungen separat ein)
• --no-git-sort-by-changes : Deaktivieren Sie das Sortieren von Dateien nach der Anzahl der Git-Änderungen (standardmäßig aktiviert).

Filteroptionen

• --include <patterns> : Liste der Include-Muster (durch Kommas getrennt)
• -i, --ignore <patterns> : Zusätzliche Ignoriermuster (durch Kommas getrennt)
• --no-gitignore : Deaktiviert die Verwendung von .gitignore-Dateien
• --no-default-patterns : Standardmuster deaktivieren

Remote-Repository-Optionen

• --remote <url> : Verarbeitet ein Remote-Git-Repository
• --remote-branch <name> : Geben Sie den Namen, das Tag oder den Commit-Hash des Remote-Zweigs an (standardmäßig der Standard-Zweig des Repositorys).

Konfigurationsoptionen

• -c, --config <path> : Pfad zu einer benutzerdefinierten Konfigurationsdatei
• --init : Konfigurationsdatei erstellen
• --global : Globale Konfiguration verwenden

Sicherheitsoptionen

• --no-security-check : Sicherheitsüberprüfung deaktivieren

Optionen zur Tokenanzahl

• --token-count-encoding <encoding> : Geben Sie die vom Tiktoken -Tokenizer von OpenAI verwendete Token-Zählkodierung an (z. B. o200k_base für GPT-4o, cl100k_base für GPT-4/3.5). Weitere Kodierungsdetails finden Sie in Tiktoken model.py .

MCP

• --mcp : Als MCP-Server (Model Context Protocol) ausführen

Weitere Optionen

• --top-files-len <number> : Anzahl der Top-Dateien, die in der Zusammenfassung angezeigt werden sollen
• --verbose : Ausführliches Protokollieren aktivieren
• --quiet : Deaktiviert die gesamte Ausgabe an stdout

Beispiele:

Aktualisieren von Repomix

So aktualisieren Sie einen global installierten Repomix:

Die Verwendung npx repomix ist im Allgemeinen bequemer, da immer die neueste Version verwendet wird.

Remote-Repository-Verarbeitung

Repomix unterstützt die Verarbeitung von Remote-Git-Repositorys ohne manuelles Klonen. Mit dieser Funktion können Sie jedes öffentliche Git-Repository schnell mit einem einzigen Befehl analysieren.

Um ein Remote-Repository zu verarbeiten, verwenden Sie die Option --remote , gefolgt von der Repository-URL:

Sie können auch das Kurzformat von GitHub verwenden:

Sie können den Branch-Namen, das Tag oder den Commit-Hash angeben:

Oder verwenden Sie einen bestimmten Commit-Hash:

Code-Komprimierung

Die Option --compress nutzt Tree-sitter zur intelligenten Codeextraktion. Dabei wird der Fokus auf wesentliche Funktions- und Klassensignaturen gelegt, während Implementierungsdetails entfernt werden. Dies kann dazu beitragen, die Tokenanzahl zu reduzieren und gleichzeitig wichtige Strukturinformationen zu erhalten.

Beispielsweise dieser Code:

Wird komprimiert auf:

[!NOTE] Dies ist eine experimentelle Funktion, die wir basierend auf Benutzerfeedback und realer Nutzung aktiv verbessern werden.

MCP-Server-Integration

Repomix unterstützt das Model Context Protocol (MCP) und ermöglicht KI-Assistenten die direkte Interaktion mit Ihrem Code. Als MCP-Server bietet Repomix Tools, mit denen KI-Assistenten lokale oder Remote-Repositories für die Analyse packen können, ohne dass eine manuelle Dateivorbereitung erforderlich ist.

Konfigurieren von MCP-Servern

Um Repomix als MCP-Server mit KI-Assistenten wie Claude zu verwenden, müssen Sie die MCP-Einstellungen konfigurieren:

Für VS Code:

Sie können den Repomix MCP-Server in VS Code mit einer der folgenden Methoden installieren:

1. Verwenden des Installationsabzeichens:

2. Verwenden der Befehlszeile:

Für VS Code Insider:

Für Cline (VS Code-Erweiterung):

Bearbeiten Sie die Datei cline_mcp_settings.json :

Für Cursor:

Fügen Sie in Cursor einen neuen MCP-Server über Cursor Settings > MCP > + Add new global MCP server .

Für Claude Desktop:

Bearbeiten Sie die Datei claude_desktop_config.json mit einer ähnlichen Konfiguration wie Clines Konfiguration.

Docker statt npx verwenden:

Sie können Docker als Alternative zu npx verwenden, um Repomix als MCP-Server auszuführen:

Nach der Konfiguration kann Ihr KI-Assistent die Funktionen von Repomix direkt nutzen, um Codebasen ohne manuelle Dateivorbereitung zu analysieren, wodurch die Arbeitsabläufe der Codeanalyse effizienter werden.

Verfügbare MCP-Tools

Beim Betrieb als MCP-Server stellt Repomix die folgenden Tools bereit:

1. pack_codebase : Packen Sie ein lokales Codeverzeichnis in eine konsolidierte XML-Datei für die KI-Analyse

• Parameter:
  • directory : Absoluter Pfad zum zu packenden Verzeichnis
  • compress : (Optional, Standard: false) Aktivieren Sie die Tree-Sitter-Komprimierung, um wichtige Code-Signaturen und Strukturen zu extrahieren und gleichzeitig Implementierungsdetails zu entfernen. Reduziert den Token-Verbrauch um ca. 70 %, während die semantische Bedeutung erhalten bleibt. Im Allgemeinen nicht erforderlich, da grep_repomix_output inkrementellen Inhaltsabruf ermöglicht. Verwenden Sie diese Option nur, wenn Sie den gesamten Codebasis-Inhalt für große Repositories benötigen.
  • includePatterns : (Optional) Geben Sie die einzubindenden Dateien mit Fast-Glob-Mustern an. Mehrere Muster können durch Kommas getrennt werden (z. B. " /*.{js,ts}", "src/ ,docs/**"). Nur übereinstimmende Dateien werden verarbeitet.
  • ignorePatterns : (Optional) Geben Sie zusätzliche auszuschließende Dateien mithilfe von Fast-Glob-Mustern an. Mehrere Muster können durch Kommas getrennt werden (z. B. „test/ ,*.spec.js“, „node_modules/ ,dist/**“). Diese Muster ergänzen .gitignore und integrierte Ausschlüsse.
  • topFilesLength : (Optional, Standard: 10) Anzahl der größten Dateien nach Größe, die in der Metrikübersicht für die Codebasisanalyse angezeigt werden sollen.

2. pack_remote_repository : Abrufen, Klonen und Verpacken eines GitHub-Repositorys in eine konsolidierte XML-Datei für die KI-Analyse

• Parameter:
  • remote : URL des GitHub-Repositorys oder Benutzer-/Repository-Format (z. B. „yamadashy/repomix“, „ https://github.com/user/repo “ oder „ https://github.com/user/repo/tree/branch “)
  • compress : (Optional, Standard: false) Aktivieren Sie die Tree-Sitter-Komprimierung, um wichtige Code-Signaturen und Strukturen zu extrahieren und gleichzeitig Implementierungsdetails zu entfernen. Reduziert den Token-Verbrauch um ca. 70 %, während die semantische Bedeutung erhalten bleibt. Im Allgemeinen nicht erforderlich, da grep_repomix_output inkrementellen Inhaltsabruf ermöglicht. Verwenden Sie diese Option nur, wenn Sie den gesamten Codebasis-Inhalt für große Repositories benötigen.
  • includePatterns : (Optional) Geben Sie die einzubindenden Dateien mit Fast-Glob-Mustern an. Mehrere Muster können durch Kommas getrennt werden (z. B. " /*.{js,ts}", "src/ ,docs/**"). Nur übereinstimmende Dateien werden verarbeitet.
  • ignorePatterns : (Optional) Geben Sie zusätzliche auszuschließende Dateien mithilfe von Fast-Glob-Mustern an. Mehrere Muster können durch Kommas getrennt werden (z. B. „test/ ,*.spec.js“, „node_modules/ ,dist/**“). Diese Muster ergänzen .gitignore und integrierte Ausschlüsse.
  • topFilesLength : (Optional, Standard: 10) Anzahl der größten Dateien nach Größe, die in der Metrikübersicht für die Codebasisanalyse angezeigt werden sollen.

3. read_repomix_output : Liest den Inhalt einer von Repomix generierten Ausgabedatei. Unterstützt partielles Lesen mit Zeilenbereichsangabe für große Dateien.

• Parameter:
  • outputId : ID der zu lesenden Repomix-Ausgabedatei
  • startLine : (Optional) Startzeilennummer (basierend auf 1, einschließlich). Wenn nicht angegeben, wird vom Anfang an gelesen.
  • endLine : (Optional) Endzeilennummer (1-basiert, inklusive). Wenn nicht angegeben, wird bis zum Ende gelesen.
• Merkmale:
  • Speziell für webbasierte Umgebungen oder Sandbox-Anwendungen entwickelt
  • Ruft den Inhalt zuvor generierter Ausgaben anhand ihrer ID ab
  • Bietet sicheren Zugriff auf gepackte Codebasis, ohne dass ein Zugriff auf das Dateisystem erforderlich ist
  • Unterstützt das teilweise Lesen großer Dateien

4. grep_repomix_output : Suche nach Mustern in einer Repomix-Ausgabedatei mithilfe einer grep-ähnlichen Funktionalität mit JavaScript-RegExp-Syntax

• Parameter:
  • outputId : ID der zu durchsuchenden Repomix-Ausgabedatei
  • pattern : Suchmuster (JavaScript RegExp-Syntax für reguläre Ausdrücke)
  • contextLines : (Optional, Standard: 0) Anzahl der Kontextzeilen, die vor und nach jeder Übereinstimmung angezeigt werden sollen. Wird durch beforeLines/afterLines überschrieben, falls angegeben.
  • beforeLines : (Optional) Anzahl der Kontextzeilen, die vor jedem Treffer angezeigt werden sollen (wie grep -B). Hat Vorrang vor contextLines.
  • afterLines : (Optional) Anzahl der Kontextzeilen, die nach jedem Treffer angezeigt werden sollen (wie grep -A). Hat Vorrang vor contextLines.
  • ignoreCase : (Optional, Standard: false) Führt einen Abgleich ohne Berücksichtigung der Groß- und Kleinschreibung durch
• Merkmale:
  • Verwendet die JavaScript-RegExp-Syntax für leistungsstarke Mustererkennung
  • Unterstützt Kontextzeilen zum besseren Verständnis von Übereinstimmungen
  • Ermöglicht die separate Steuerung von Kontextzeilen vor/nach
  • Groß- und Kleinschreibung beachtende Suchoptionen

5. file_system_read_file : Liest eine Datei aus dem lokalen Dateisystem unter Angabe eines absoluten Pfads. Enthält eine integrierte Sicherheitsüberprüfung, um den Zugriff auf Dateien mit vertraulichen Informationen zu erkennen und zu verhindern.

• Parameter:
  • path : Absoluter Pfad zur zu lesenden Datei
• Sicherheitsfunktionen:
  • Implementiert die Sicherheitsvalidierung mit Secretlint
  • Verhindert den Zugriff auf Dateien mit vertraulichen Informationen (API-Schlüssel, Passwörter, Geheimnisse)
  • Validiert absolute Pfade, um Directory-Traversal-Angriffe zu verhindern

6. file_system_read_directory : Listet den Inhalt eines Verzeichnisses mit einem absoluten Pfad auf. Gibt eine formatierte Liste mit Dateien und Unterverzeichnissen mit eindeutigen Indikatoren zurück.

• Parameter:
  • path : Absoluter Pfad zum aufzulistenden Verzeichnis
• Merkmale:
  • Zeigt Dateien und Verzeichnisse mit eindeutigen Indikatoren ( [FILE] oder [DIR] )
  • Bietet sichere Verzeichnisdurchquerung mit ordnungsgemäßer Fehlerbehandlung
  • Validiert Pfade und stellt sicher, dass sie absolut sind
  • Nützlich zum Erkunden der Projektstruktur und zum Verstehen der Codebasisorganisation

⚙️ Konfiguration

Erstellen Sie für benutzerdefinierte Konfigurationen eine Datei repomix.config.json in Ihrem Projektstamm.

Hier ist eine Erklärung der Konfigurationsoptionen:

Die Konfigurationsdatei unterstützt die JSON5- Syntax, die Folgendes ermöglicht:

• Kommentare (sowohl einzeilig als auch mehrzeilig)
• Nachfolgende Kommas in Objekten und Arrays
• Nicht in Anführungszeichen gesetzte Eigenschaftsnamen
• Entspanntere Zeichenfolgensyntax

Beispielkonfiguration:

Globale Konfiguration

So erstellen Sie eine globale Konfigurationsdatei:

Die globale Konfigurationsdatei wird erstellt in:

• Windows: %LOCALAPPDATA%\Repomix\repomix.config.json
• macOS/Linux: $XDG_CONFIG_HOME/repomix/repomix.config.json oder ~/.config/repomix/repomix.config.json

Hinweis: Die lokale Konfiguration (sofern vorhanden) hat Vorrang vor der globalen Konfiguration.

Einschließen und Ignorieren

Muster einschließen

Repomix unterstützt nun die Angabe von einzuschließenden Dateien mithilfe von Glob-Mustern . Dies ermöglicht eine flexiblere und leistungsfähigere Dateiauswahl:

• Verwenden Sie **/*.js um alle JavaScript-Dateien in einem beliebigen Verzeichnis einzuschließen
• Verwenden Sie src/**/* um alle Dateien im src -Verzeichnis und seinen Unterverzeichnissen einzuschließen
• Kombinieren Sie mehrere Muster wie ["src/**/*.js", "**/*.md"] um JavaScript-Dateien in src und alle Markdown-Dateien einzuschließen

Muster ignorieren

Repomix bietet mehrere Methoden zum Festlegen von Ignoriermustern zum Ausschließen bestimmter Dateien oder Verzeichnisse während des Packvorgangs:

• .gitignore : Standardmäßig werden die in den .gitignore Dateien Ihres Projekts und .git/info/exclude aufgeführten Muster verwendet. Dieses Verhalten kann mit der Einstellung ignore.useGitignore oder der CLI-Option --no-gitignore gesteuert werden.
• Standardmuster : Repomix enthält eine Standardliste häufig ausgeschlossener Dateien und Verzeichnisse (z. B. node_modules, .git, Binärdateien). Diese Funktion kann mit der Einstellung ignore.useDefaultPatterns oder der CLI-Option --no-default-patterns gesteuert werden. Weitere Informationen finden Sie in defaultIgnore.ts .
• .repomixignore : Sie können eine .repomixignore -Datei im Stammverzeichnis Ihres Projekts erstellen, um Repomix-spezifische Ignoriermuster zu definieren. Diese Datei hat dasselbe Format wie .gitignore .
• Benutzerdefinierte Muster : Zusätzliche Ignoriermuster können mit der Option ignore.customPatterns in der Konfigurationsdatei angegeben werden. Sie können diese Einstellung mit der Kommandozeilenoption -i, --ignore überschreiben.

Prioritätsreihenfolge (von der höchsten zur niedrigsten):

1. Benutzerdefinierte Muster ignore.customPatterns
2. .repomixignore
3. .gitignore und .git/info/exclude (wenn ignore.useGitignore wahr ist und --no-gitignore nicht verwendet wird)
4. Standardmuster (wenn ignore.useDefaultPatterns wahr ist und --no-default-patterns nicht verwendet wird)

Dieser Ansatz ermöglicht eine flexible Konfiguration des Dateiausschlusses basierend auf den Anforderungen Ihres Projekts. Er trägt dazu bei, die Größe der generierten Packdatei zu optimieren, indem er den Ausschluss sicherheitsrelevanter Dateien und großer Binärdateien gewährleistet und gleichzeitig den Verlust vertraulicher Informationen verhindert.

Hinweis: Binärdateien sind standardmäßig nicht in der gepackten Ausgabe enthalten, ihre Pfade werden jedoch im Abschnitt „Repository-Struktur“ der Ausgabedatei aufgelistet. Dies bietet einen vollständigen Überblick über die Repository-Struktur und sorgt gleichzeitig dafür, dass die gepackte Datei effizient und textbasiert bleibt.

Benutzerdefinierte Anweisung

Mit der Option output.instructionFilePath können Sie eine separate Datei mit detaillierten Anweisungen oder Kontextinformationen zu Ihrem Projekt angeben. Dadurch können KI-Systeme den spezifischen Kontext und die Anforderungen Ihres Projekts verstehen und möglicherweise relevantere und maßgeschneiderte Analysen oder Vorschläge erstellen.

Hier ist ein Beispiel, wie Sie diese Funktion verwenden können:

1. Erstellen Sie in Ihrem Projektstamm eine Datei mit dem Namen repomix-instruction.md :

2. Fügen Sie in Ihrer repomix.config.json die Option instructionFilePath hinzu:

Wenn Repomix die Ausgabe generiert, wird der Inhalt von repomix-instruction.md in einem dedizierten Abschnitt eingefügt.

Hinweis: Der Anweisungsinhalt wird am Ende der Ausgabedatei angehängt. Diese Platzierung kann insbesondere für KI-Systeme effektiv sein. Wer verstehen möchte, warum dies von Vorteil sein könnte, findet in der Dokumentation von Anthropic einige Einblicke:
https://docs.anthropic.com/en/docs/build-with-claude/prompt-engineering/long-context-tips

Platzieren Sie lange Daten an den Anfang: Platzieren Sie Ihre langen Dokumente und Eingaben (ca. 20.000+ Token) oben in Ihrer Eingabeaufforderung, über Ihrer Abfrage, Ihren Anweisungen und Beispielen. Dies kann Claudes Leistung über alle Modelle hinweg deutlich verbessern. Abfragen am Ende können die Antwortqualität in Tests um bis zu 30 % verbessern, insbesondere bei komplexen Eingaben mit mehreren Dokumenten.

Kommentarentfernung

Wenn output.removeComments auf true gesetzt ist, versucht Repomix, Kommentare aus unterstützten Dateitypen zu entfernen. Diese Funktion kann dazu beitragen, die Größe der Ausgabedatei zu reduzieren und sich auf den wesentlichen Codeinhalt zu konzentrieren.

Zu den unterstützten Sprachen gehören:
HTML, CSS, JavaScript, TypeScript, Vue, Svelte, Python, PHP, Ruby, C, C#, Java, Go, Rust, Swift, Kotlin, Dart, Shell und YAML.

Hinweis: Der Kommentarentfernungsprozess ist konservativ, um das versehentliche Entfernen von Code zu vermeiden. In komplexen Fällen können einige Kommentare erhalten bleiben.

🔍 Sicherheitscheck

Repomix enthält eine Sicherheitsüberprüfungsfunktion, die Secretlint verwendet, um potenziell sensible Informationen in Ihren Dateien zu erkennen. Diese Funktion hilft Ihnen, mögliche Sicherheitsrisiken zu identifizieren, bevor Sie Ihr gepacktes Repository freigeben.

Die Ergebnisse der Sicherheitsüberprüfung werden nach Abschluss des Packvorgangs in der CLI-Ausgabe angezeigt. Sollten verdächtige Dateien erkannt werden, wird eine Liste dieser Dateien zusammen mit einer Warnmeldung angezeigt.

Beispielausgabe:

Standardmäßig ist die Sicherheitsüberprüfung von Repomix aktiviert. Sie können sie deaktivieren, indem Sie security.enableSecurityCheck in Ihrer Konfigurationsdatei auf false setzen:

Oder mit der Befehlszeilenoption --no-security-check :

[!NOTE] Durch das Deaktivieren von Sicherheitsüberprüfungen können vertrauliche Informationen offengelegt werden. Verwenden Sie diese Option mit Vorsicht und nur, wenn es unbedingt erforderlich ist, z. B. beim Arbeiten mit Testdateien oder Dokumentationen, die Beispielanmeldeinformationen enthalten.

🤖 Verwenden von Repomix mit GitHub Actions

Sie können Repomix auch in Ihren GitHub Actions-Workflows verwenden. Dies ist nützlich, um das Packen Ihrer Codebasis für die KI-Analyse zu automatisieren.

Grundlegende Verwendung:

Verwenden Sie --style , um Ausgaben in verschiedenen Formaten zu generieren:

Packen Sie bestimmte Verzeichnisse mit Komprimierung:

Laden Sie die Ausgabedatei als Artefakt hoch:

Vollständiges Workflow-Beispiel:

Das vollständige Workflow-Beispiel finden Sie hier .

Aktionseingaben

Aktionsausgaben

📚 Repomix als Bibliothek verwenden

Sie können Repomix nicht nur als CLI-Tool verwenden, sondern auch als Bibliothek in Ihren Node.js-Anwendungen.

Installation

Grundlegende Verwendung

Remote-Repository verarbeiten

Verwenden von Kernkomponenten

Wenn Sie mehr Kontrolle benötigen, können Sie die Low-Level-APIs verwenden:

Weitere Beispiele finden Sie im Quellcode unter website/server/src/remoteRepo.ts, der zeigt, wie repomix.com die Bibliothek verwendet.

🤝 Beitrag

Wir freuen uns über Beiträge aus der Community! Um zu beginnen, lesen Sie bitte unseren Leitfaden für Beiträge .

Mitwirkende

🔒 Datenschutzrichtlinie

Repomix CLI-Tool

• Datenerfassung : Das Repomix CLI-Tool erfasst, überträgt oder speichert keine Benutzerdaten, Telemetriedaten oder Repository-Informationen.
• Netzwerknutzung : Repomix CLI arbeitet nach der Installation vollständig offline. Eine Internetverbindung ist nur in folgenden Fällen erforderlich:
  • Installation über npm/yarn.
  • Verwenden des Flags --remote zum Verarbeiten von Remote-Repositorys.
  • Suche nach Updates (manuell ausgelöst).
• Sicherheitsüberlegungen : Da die gesamte Verarbeitung lokal erfolgt, kann Repomix CLI sicher mit privaten und internen Repositories verwendet werden.

Repomix-Website ( repomix.com )

• Datenerfassung : Die Repomix-Website verwendet Google Analytics, um Nutzungsdaten wie Seitenaufrufe und Benutzerinteraktionen zu erfassen. Dies hilft uns zu verstehen, wie die Website genutzt wird, und das Benutzererlebnis zu verbessern.

Haftungsausschluss

Repomix (sowohl das CLI-Tool als auch die Website) wird „wie besehen“ ohne jegliche Gewährleistungen oder Garantien bereitgestellt.
Wir übernehmen keine Verantwortung für die Verwendung der generierten Ausgabe, einschließlich, aber nicht beschränkt auf deren Richtigkeit, Rechtmäßigkeit oder mögliche Folgen, die sich aus ihrer Verwendung ergeben.

📜 Lizenz

Dieses Projekt ist unter der MIT-Lizenz lizenziert.