Erste Schritte
SourceAnt hilft Ihnen, Ihren Code zu verstehen, wie Ihre Systeme zusammenwirken und welches Wissen Ihr Team bei der Arbeit aufbaut. Dieses Verständnis macht Reviews zu einem Qualitätstor für Änderungen, auch für solche, die andere Repositories im selben System betreffen.
Starten Sie in der Cloud
Sie benötigen ein GitHub-Repository, die Berechtigung, die SourceAnt GitHub App darauf zu installieren, und einen API-Schlüssel für das Modell, das Sie verwenden möchten. Sie müssen die CLI nicht installieren.
- Melden Sie sich bei SourceAnt an und wählen Sie einen persönlichen oder Team-Arbeitsbereich. Hier verbinden Sie das Repository und pflegen dessen Wissen.
- Installieren Sie die SourceAnt GitHub App auf dem Konto oder der Organisation, dem/der das Repository gehört, und gewähren Sie ihr Zugriff auf dieses Repository.
- Wählen Sie das Repository in SourceAnt aus und klicken Sie auf Verbinden & fortfahren.
- Wählen Sie einen Modellanbieter und ein Modell, geben Sie Ihren API-Schlüssel ein und speichern Sie diese.
- Klicken Sie auf Scan starten um das Repository im Hintergrund zu lesen. Überprüfen Sie das resultierende Wissen und die Systemstruktur im Dashboard.
- Öffnen Sie einen Pull Request im verbundenen Repository und prüfen Sie GitHub auf das Review.
Für Screenshots, optionale Schritte und Setup-Prüfungen folgen Sie Cloud-Einrichtung.
Arbeiten Sie lokal mit der CLI
Verwenden Sie SourceAnt lokal, um Ihren Code und Ihr Wissen zu erkunden, Skills zu verwalten und Änderungen damit abzugleichen, bevor Sie Ihre Arbeit teilen.
curl -fsSL https://raw.githubusercontent.com/sourceant/cli/main/scripts/install.sh | sh
sourceant setup
sourceant ui
Fügen Sie ein Repository über das Panel hinzu. Um es von Ihrem Editor aus zu nutzen, verbinden Sie einen MCP-Client mit
http://127.0.0.1:8930/mcp. MCP ist das Protokoll, das Ihr Coding-Assistent verwendet, um die Tools von SourceAnt aufzurufen.
Siehe Lokale Einrichtung für Installation, Modellkonfiguration und Editor-Zugriff.
Betreiben Sie Ihren eigenen Server
Um die Review-API mit Docker-Images auf Ihrem eigenen Server zu hosten, folgen Sie der GitHub App-Einrichtungsanleitung um Pull-Request-Ereignisse auf Ihrem Server zu empfangen. Dies ist unabhängig von der Installation der gehosteten SourceAnt App auf GitHub.
Prüfen Sie, was SourceAnt gelernt hat
Offen Knowledge um die gefundenen Entscheidungen und Einschränkungen zu inspizieren. Öffnen Sie Systeme um zu prüfen, wie die Repositories gruppiert und verbunden sind. Korrigieren Sie diese Datensätze, bevor Sie sich als Kontext für spätere Reviews darauf verlassen.
Finden Sie sich zurecht
Verwenden Sie die Suchschaltfläche in der Dashboard-Navigation oder drücken Sie Strg+K (Befehl+K unter macOS). Die Suche bietet Seiten zum Öffnen und, auf unterstützten Seiten, Datensätze aus der aktuellen Ansicht. Sie durchsucht die von dieser Seite geladenen Datensätze und nicht jeden Datensatz im Arbeitsbereich. Verwenden Sie die Pfeiltasten und Enter, um ein Ergebnis auszuwählen, oder Escape, um zu schließen.
Nächste Schritte
- Code-Review: die Review-Ausgabe verstehen.
- Knowledge-Management: den von Ihren Tools verwendeten Kontext kuratieren.
- Systeme: zugehörige Repositories gruppieren und ihre Verbindungen entdecken.
- Architektur-Prüfung: Codestruktur erkunden und lokale Snapshots vergleichen.
- Skills: wiederverwendbare Anweisungen mit verbundenen Tools teilen.
- Anforderungen: Arbeit organisieren und Implementierungs- und Testverknüpfungen verfolgen.
- Analytics: Aktivität und Modellausgaben inspizieren.