Dokumentation
Mit vetkit entwickeln
Alles, was Sie in der vetkit-App tun können, ist auch programmatisch verfügbar. Beginnen Sie mit einem API-Schlüssel und wählen Sie dann die Schnittstelle, die zu Ihrem Workflow passt.
- MCP-ServerGeben Sie Claude Code oder einem beliebigen MCP-Client Tools, um Repos zu verbinden, Audits auszuführen und Befunde zu lesen.
- REST-APIAuthentifizieren Sie sich mit einem API-Schlüssel, starten Sie Audits aus der CI, fragen Sie Ergebnisse ab und laden Sie SARIF herunter.
Schnellstart
- Fordern Sie Early Access an. Sobald Sie freigeschaltet sind, melden Sie sich mit GitHub an und installieren Sie die vetkit GitHub App für die Repositorys, die Sie prüfen möchten.
- Öffnen Sie in der App Einstellungen → API-Schlüssel und erstellen Sie einen Schlüssel mit den benötigten Scopes. Das Secret wird nur einmal angezeigt — speichern Sie es in Ihrem Passwortmanager oder Secret-Store.
- Folgen Sie der MCP-Anleitung, um vetkit aus Ihrem Coding-Agenten zu nutzen, oder der API-Anleitung, um es aus Skripten und CI aufzurufen.
Konzepte
- Organisation — besitzt Repositorys, Audits und API-Schlüssel. Jede Person erhält eine persönliche Organisation; Team-Organisationen haben zusätzlich Mitglieder mit Rollen.
- Repository — ein GitHub-Repository, das über die vetkit GitHub App verbunden ist.
- Audit — ein Durchlauf aller Analyzer für einen bestimmten Commit. Der Status wechselt von
QUEUEDüberRUNNINGzuSUCCEEDED,FAILEDoderCANCELLED. - Befund — ein einzelnes Problem mit Kategorie, Schweregrad, Regel, Datei und Zeile. Befunde erhalten einen Fingerprint, sodass erneute Audits sie als neu oder bestehend kennzeichnen.
- Bericht — die benotete Zusammenfassung eines Audits, verfügbar als JSON, Markdown oder SARIF 2.1.0.