Repomix: Verpackung der Code-Basis in eine Textdatei für den Abruf großer Modelle

Allgemeine Einführung

Repomix (früher bekannt als Repopack) ist ein Open-Source-Tool, mit dem eine gesamte Codebasis in eine einzige, KI-freundliche Datei verpackt werden kann. Dieses Tool ermöglicht es Entwicklern, ihre Codebasis auf einfache Weise für die Analyse und Verarbeitung durch große Sprachmodelle wie Claude, ChatGPT und Gemini bereitzustellen. Ursprünglich wurde es entwickelt, um die Aufgabe der KI beim Verstehen und Generieren von Code für Szenarien zu vereinfachen, die eine schnelle Überprüfung oder ein Refactoring der Codebasis erfordern. Repomix unterstützt eine Vielzahl von Ausgabeformaten, darunter XML, Markdown und reinen Text, und bietet Profile, die den Anforderungen verschiedener Projekte entsprechen.

Funktionsliste

• Verpackung der CodebasisPaketieren Sie das gesamte Projekt in eine einzige Datei, um die KI-Analyse zu erleichtern.
• Unterstützung von Multiformat-AusgabenBietet verschiedene Ausgabeformate wie XML, Markdown und reinen Text, die vom Benutzer nach Belieben ausgewählt werden können.
• Flexibilität bei der KonfigurationÜber die Konfigurationsdatei können Sie Optionen wie das Ignorieren von Dateien, das Entfernen von Kommentaren usw. individuell einstellen.
• Fernwartung im LagerSie können Code direkt von einem entfernten GitHub-Repository abrufen und verpacken.
• Docker-UnterstützungDocker-Images werden bereitgestellt, um die Ausführung von Repomix in einer Container-Umgebung zu erleichtern.
• SicherheitsprüfungSicherheitsprüfungen sind standardmäßig aktiviert, um die Weitergabe sensibler Informationen zu verhindern.

Hilfe verwenden

Installation von Repomix

Repomix ist ein Node.js-basiertes Tool, daher müssen Sie sicherstellen, dass Sie Node.js auf Ihrem System installiert haben.

1.Installation von Node.js::

• Besuchen Sie die offizielle Node.js-Website, um die entsprechende Version für Ihr System herunterzuladen und zu installieren.

2.Installation von Repomix::

• Installieren Sie Repomix global über npm:

  npm install -g repomix
  

Repomix verwenden

Grundlegende Verwendung

• Verpackung lokaler Projekte::
  Wechseln Sie in Ihr Projektverzeichnis und führen Sie es aus:

Repomix

Dies erzeugt eine Datei im aktuellen Verzeichnis mit dem Namenrepomix-ausgabe.xmlder Datei. Wenn Sie das Ausgabeformat angeben müssen, können Sie ** --style verwendenParameter:

repomix --style markdown

• Verpackung Remote-Lager::
  Wenn Sie ein entferntes GitHub-Repository direkt verpacken möchten, führen Sie es aus:

  repomix --remote https://github.com/yamadashy/repomix
  

  Sie können auch Zweige oder bestimmte Commits angeben:

  repomix --remote yamadashy/repomix --remote-branch main
  

Konfigurationsdatei

• Repomix unterstützt benutzerdefinierte Konfigurationen, die über dierepomix --initErzeugen einerrepomix.config.jsonDokument. Sie können darin definieren:
  • Dateien ignorieren: **.repomixignore verwendenDatei oder Konfigurationsdatei in derignorieren.Option, ähnlich wie bei der.gitignore**.
  • AusgabeformatWählen Sie das Format der Ausgabedatei (z. B. XML, Markdown).
  • Text der ÜberschriftErklärender Text am Anfang der Ausgabedatei hinzufügen.
  • Sicherheitsprüfung: Ob Sicherheitsüberprüfungen aktiviert werden sollen, um die Offenlegung sensibler Informationen zu vermeiden.

  Beispiel für eine Konfigurationsdatei:

  {
  "output": {
  "filePath": "repomix-output.xml",
  "Stil": "xml",
  "fileSummary": true
  }, "fileSummary": true
  "ignore": {
  "useGitignore": true
  }
  }
  

Laufender Repomix

• Ausführung in Docker::
  Wenn Sie es vorziehen, Ihre Umgebung mit Docker zu verwalten, können Sie dies tun:

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

Repomix zur Verwendung mit anderen AI-Tools

• Die erzeugte Einzeldatei kann direkt in KI-Tools wie Claude, ChatGPT oder Gemini zur Analyse hochgeladen werden:
  • Code-ÜberprüfungBereitstellung von Unterlagen für die KI, die eine Codeüberprüfung anfordern oder eine Überarbeitung vorschlagen.
  • DokumentenerstellungGenerieren von Dokumentation oder README-Dateien auf der Grundlage der Codebasis.
  • Lösung von ProblemenIdentifizierung von Problemen im Code und Bereitstellung von Lösungen durch KI-Tools.