Sunwood-ai-labs/SourceSage

SourceSage CLI

Übersicht

Verwenden Sie die SourceSage CLI aus diesem Repository-Checkout, um Repository-Zusammenfassungen für das aktuelle Repository oder ein anderes lokales Repository zu generieren.

Bevorzugen Sie das lokale Checkout gegenüber der Annahme, dass sourcesage global installiert ist. In diesem Repository-Layout ist das SourceSage-Tool-Root das Verzeichnis, das diese SKILL.md enthält.

Arbeitsablauf

1. Ermitteln Sie das SourceSage-Tool-Root und das Ziel-Repository.

   • Falls der Benutzer kein anderes Repository angegeben hat, analysieren Sie den aktuellen Arbeitsbereich.
   • Falls der aktuelle Arbeitsbereich nicht das SourceSage-Repository ist, führen Sie SourceSage aus seinem eigenen Checkout mit uv run --directory <sourcesage-root> sage ... aus.

2. Wählen Sie den kleinsten Befehl, der die Anforderung erfüllt.

   • Aktuelle Repository-Zusammenfassung: uv run sage
   • Aktuelle Repository-Zusammenfassung im Lite-Modus: uv run sage --lite
   • Aktuelle Repository-Zusammenfassung auf Japanisch: uv run sage -l ja
   • Ein anderes Repository mit Standardausgabe in diesem Repository: uv run --directory <sourcesage-root> sage --repo "<target-repo>"
   • Ein anderes Repository im Lite-Modus: uv run --directory <sourcesage-root> sage --repo "<target-repo>" --lite
   • Ein anderes Repository mit explizitem Ausgabeverzeichnis: uv run --directory <sourcesage-root> sage --repo "<target-repo>" -o "<output-dir>"
   • Veralteter Diff-Report: uv run --directory <sourcesage-root> sage --repo "<target-repo>" --diff

3. Überprüfen Sie die generierten Artefakte nach jedem Durchlauf.

   • Repository-Zusammenfassung: <output-dir>/.SourceSageAssets/Repository_summary.md
   • Veralteter Diff-Report: <output-dir>/.SourceSageAssets/RELEASE_REPORT/Report_<latest-tag>.md
   • Öffnen Sie das generierte Markdown und fassen Sie die wichtigen Ergebnisse zusammen, anstatt nur zu melden, dass der Befehl ausgeführt wurde.
   • Im --lite-Modus bestätigen Sie, dass die Zusammenfassung den Baum, Git-Informationen, Statistiken und README-Dateien des Roots enthält, während der Abschnitt ## Dateiinhalte weggelassen wird.

4. Melden Sie Nebeneffekte und Befehlsinkonsistenzen.

   • Erwarten Sie, dass SourceSage <repo>/.SourceSageignore erstellt, falls es nicht existiert.
   • Behandeln Sie --ignore-file als die unterstützte Ignore-Überschreibung.
   • Verlassen Sie sich nicht auf --use-ignore, es sei denn, die CLI wurde aktualisiert und erneut überprüft, da die aktuelle CLI dieses Flag nicht bereitstellt.

Befehlsnotizen

• Bevorzugen Sie uv run sage innerhalb des SourceSage-Repositorys, da die pyproject.toml sowohl sage als auch sourcesage als Einstiegspunkte definiert.
• Bevorzugen Sie uv run --directory <sourcesage-root> sage ... außerhalb des SourceSage-Repositorys, damit der Befehl dieses Checkout verwendet, ohne eine globale Installation zu erfordern.
• Fallen Sie nur dann direkt auf sourcesage oder sage zurück, wenn das Paket bereits installiert ist und uv nicht verfügbar ist.
• Verwenden Sie -l ja oder -l en für die Ausgabesprache.
• Verwenden Sie --lite für die erste Erkundung, wenn Ignore-Regeln noch nicht abgestimmt sind oder wenn vollständige Dateiauszüge die Zusammenfassung zu groß machen würden.
• Verwenden Sie -o, wenn der Benutzer Artefakte außerhalb des Repository-Roots wünscht.
• Verwenden Sie --repo, um ein anderes Repository von diesem Checkout aus zu analysieren.

Validierung

• Führen Sie den ausgewählten Befehl aus, anstatt ihn nur zu beschreiben.
• Bestätigen Sie, dass die erwartete Markdown-Datei existiert.
• Lesen Sie die generierte Ausgabe und melden Sie den Pfad sowie eine kurze Zusammenfassung dessen, was erzeugt wurde.
• Führen Sie den exakten Befehl erneut aus, nachdem Sie Anweisungen oder Dokumentationen geändert haben, die ihn erwähnen.

Vermeiden

• Gehen Sie nicht davon aus, dass README-Beispiele maßgeblich sind, wenn sie von sourcesage/cli.py abweichen.
• Überschreiben Sie keine vorhandenen Artefakte stillschweigend, wenn der Benutzer ein bestimmtes Ziel angefordert hat und dieses bereits Ergebnisse enthält.
• Beschreiben Sie die SourceSage-Nutzung nicht aus dem Gedächtnis, wenn Sie pyproject.toml und sourcesage/cli.py in diesem Repository einsehen können.