GitHub-Repository-Verarbeitung
Grundlegende Verwendung
Öffentliche Repositories verarbeiten:
# Mit vollständiger URL
repomix --remote https://github.com/user/repo
# Mit GitHub-Kurzform
repomix --remote user/repoSie können die owner/repo-Kurzform auch direkt ohne --remote übergeben:
repomix yamadashy/repomixDa owner/repo auch wie ein relativer lokaler Pfad aussieht, behandelt Repomix das Argument nur dann als Remote-Repository, wenn keine lokale Datei bzw. kein Verzeichnis mit diesem Namen existiert und das Repository auf GitHub erreichbar ist. Ein vorhandener lokaler Pfad hat immer Vorrang; um einen Pfad in owner/repo-Form als lokal zu erzwingen, stellen Sie ihm ./ voran (zum Beispiel repomix ./owner/repo). Wenn das Argument dem Muster entspricht, das Repository aber nicht erreichbar ist (zum Beispiel ein privates Repository oder ein Tippfehler), behandelt Repomix es ersatzweise als lokalen Pfad.
Branch- und Commit-Auswahl
# Bestimmter Branch
repomix --remote user/repo --remote-branch main
# Tag
repomix --remote user/repo --remote-branch v1.0.0
# Commit-Hash
repomix --remote user/repo --remote-branch 935b695Voraussetzungen
- Git muss installiert sein
- Internetverbindung
- Lesezugriff auf das Repository
Ausgabekontrolle
# Benutzerdefinierter Ausgabeort
repomix --remote user/repo -o custom-output.xml
# Mit XML-Format
repomix --remote user/repo --style xml
# Kommentare entfernen
repomix --remote user/repo --remove-commentsDocker-Verwendung
# Verarbeitung und Ausgabe in das aktuelle Verzeichnis
docker run -v .:/app -it --rm ghcr.io/yamadashy/repomix \
--remote user/repo
# Ausgabe in bestimmtes Verzeichnis
docker run -v ./output:/app -it --rm ghcr.io/yamadashy/repomix \
--remote user/repoSicherheit
Aus Sicherheitsgründen werden Konfigurationsdateien (repomix.config.*) in Remote-Repositories standardmäßig nicht geladen. Dadurch wird verhindert, dass nicht vertrauenswürdige Repositories über Konfigurationsdateien wie repomix.config.ts Code ausführen.
Ihre globale Konfiguration und CLI-Optionen werden weiterhin angewendet.
Um der Konfiguration eines Remote-Repositorys zu vertrauen:
# Per CLI-Flag
repomix --remote user/repo --remote-trust-config
# Per Umgebungsvariable
REPOMIX_REMOTE_TRUST_CONFIG=true repomix --remote user/repoBei Verwendung von --config mit --remote ist ein absoluter Pfad erforderlich:
repomix --remote user/repo --config /home/user/repomix.config.jsonHäufige Probleme
Zugriffsprobleme
- Stellen Sie sicher, dass das Repository öffentlich ist
- Überprüfen Sie die Git-Installation
- Überprüfen Sie die Internetverbindung
Große Repositories
- Verwenden Sie
--include, um bestimmte Pfade auszuwählen - Aktivieren Sie
--remove-comments - Verarbeiten Sie Branches separat
Verwandte Ressourcen
- Befehlszeilenoptionen - Vollständige CLI-Referenz einschließlich
--remote-Optionen - Konfiguration - Standardoptionen für Remote-Verarbeitung einrichten
- Code-Komprimierung - Ausgabegröße für große Repositories reduzieren
- Sicherheit - Wie Repomix sensible Daten erkennt