Repomix

Schnellstart ​

Sobald Sie mit Repomix eine gepackte Datei (repomix-output.txt) erstellt haben, können Sie diese mit einer Aufforderung wie dieser an einen KI-Assistenten senden:

Diese Datei enthält alle Dateien im Repository in einer Datei zusammengefasst.
Ich möchte den Code refaktorieren, bitte überprüfen Sie ihn zuerst.

Die KI wird Ihren gesamten Codebase analysieren und umfassende Einblicke geben:

Bei der Diskussion spezifischer Änderungen kann die KI bei der Code-Generierung helfen. Mit Funktionen wie Claudes Artifacts können Sie sogar mehrere voneinander abhängige Dateien erhalten:

Viel Spaß beim Programmieren! 🚀

Leitfaden für fortgeschrittene Benutzer ​

Für fortgeschrittene Benutzer, die mehr Kontrolle benötigen, bietet Repomix umfangreiche Anpassungsmöglichkeiten über seine CLI-Schnittstelle.

Schnellstart ​

Sie können Repomix sofort in Ihrem Projektverzeichnis ohne Installation ausprobieren:

npx repomix

Oder installieren Sie es global für wiederholte Verwendung:

# Installation mit npm
npm install -g repomix

# Alternativ mit yarn
yarn global add repomix

# Alternativ mit Homebrew (macOS/Linux)
brew install repomix

# Dann in einem beliebigen Projektverzeichnis ausführen
repomix

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

Verwendung ​

Um Ihr gesamtes Repository zu packen:

repomix

Um ein bestimmtes Verzeichnis zu packen:

repomix path/to/directory

Um bestimmte Dateien oder Verzeichnisse mit Glob-Mustern zu packen:

repomix --include "src/**/*.ts,**/*.md"

Um bestimmte Dateien oder Verzeichnisse auszuschließen:

repomix --ignore "**/*.log,tmp/"

Um ein Remote-Repository zu packen:

# Kurzform verwenden
npx repomix --remote yamadashy/repomix

# Vollständige URL verwenden (unterstützt Branches und spezifische Pfade)
npx repomix --remote https://github.com/yamadashy/repomix
npx repomix --remote https://github.com/yamadashy/repomix/tree/main

# Commit-URL verwenden
npx repomix --remote https://github.com/yamadashy/repomix/commit/836abcd7335137228ad77feb28655d85712680f1

Um eine neue Konfigurationsdatei (repomix.config.json) zu initialisieren:

repomix --init

Sobald Sie die gepackte Datei erstellt haben, können Sie sie mit generativen KI-Tools wie Claude, ChatGPT und Gemini verwenden.

Docker-Verwendung ​

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

Grundlegende Verwendung (aktuelles Verzeichnis):

docker run -v .:/app -it --rm ghcr.io/yamadashy/repomix

Um ein bestimmtes Verzeichnis zu packen:

docker run -v .:/app -it --rm ghcr.io/yamadashy/repomix path/to/directory

Ein Remote-Repository verarbeiten und in ein output-Verzeichnis ausgeben:

docker run -v ./output:/app -it --rm ghcr.io/yamadashy/repomix --remote https://github.com/yamadashy/repomix

Ausgabeformate ​

Wählen Sie Ihr bevorzugtes Ausgabeformat:

# XML-Format (Standard)
repomix --style xml

# Markdown-Format
repomix --style markdown

# Klartext-Format
repomix --style plain

Anpassung ​

Erstellen Sie eine repomix.config.json für dauerhafte Einstellungen:

{
  "output": {
    "style": "markdown",
    "filePath": "custom-output.md",
    "removeComments": true,
    "showLineNumbers": true,
    "topFilesLength": 10
  },
  "ignore": {
    "customPatterns": ["*.test.ts", "docs/**"]
  }
}

Weitere Beispiele ​