HeyDeer CLI
Prüfen Sie Ihren Branch und nicht committete Änderungen im Terminal, bevor Sie einen Pull Request öffnen. Die HeyDeer CLI zeigt die Befunde dort an, wo Sie arbeiten, und auch Coding-Agents können sie ausführen.
Installieren und anmelden
Die CLI benötigt Node.js 22 oder neuer, ein Repository auf GitHub mit installiertem HeyDeer und Schreibzugriff auf dieses Repository.
npm install -g heydeer
heydeer loginheydeer login gibt einen Link und einen Code aus. Öffnen Sie den Link, melden Sie sich mit GitHub bei HeyDeer an und geben Sie den Code ein. Die Seite zeigt, von wo die Anmeldung angefordert wurde. Prüfen Sie also, ob es Ihr Computer ist, bevor Sie sie erlauben.
| Befehl | Wirkung |
|---|---|
heydeer login | Meldet sich auf diesem Computer bei HeyDeer an. |
heydeer status | Zeigt, in wessen Namen die CLI handelt. |
heydeer logout | Meldet sich auf diesem Computer ab. |
heydeer --version | Zeigt die installierte Version der CLI. |
Die CLI speichert ihre Anmeldung in ~/.config/heydeer/credentials.json, unter Windows in %APPDATA%\heydeer. Eine Anmeldung gilt 30 Tage nach der letzten Nutzung und höchstens 90 Tage. Danach führen Sie heydeer login erneut aus.
Änderungen prüfen
Starten Sie die Prüfung im Repository und beschreiben Sie in einem Satz, was die Änderungen bewirken sollen:
heydeer review "Retry failed uploads. Fixes #123."HeyDeer prüft die Commits auf Ihrem Branch und die nicht committeten Änderungen an verfolgten Dateien gegen die Merge-Basis mit dem Standard-Branch von origin. Die Beschreibung liest HeyDeer wie die eines Pull Requests, einschließlich der erwähnten Issues, und prüft den Code dagegen. Längere Beschreibungen schreiben Sie in eine Datei und übergeben sie mit --description-file.
Die CLI zeigt Repository, Basis, Branch und Prüftiefe, listet die gesendeten Dateien auf und verfolgt den Fortschritt der Prüfung. Ist die Prüfung fertig, gibt sie jeden Befund mit Schweregrad, Datei und Zeile aus.
Optionen
| Option | Wirkung |
|---|---|
--description-file <path> | Liest die Beschreibung aus einer Datei statt von der Befehlszeile. |
--base <ref> | Vergleicht mit einem anderen Branch oder Commit, für Arbeit, die darauf abzielt. |
--include-untracked | Prüft auch neue Dateien, die Sie noch nicht zu Git hinzugefügt haben, sofern sie nicht per gitignore ausgeschlossen sind. |
--depth standard|deep | Führt diese Prüfung mit einer anderen Prüftiefe als der des Repositorys aus. Tiefgehend ist in kostenpflichtigen Tarifen enthalten. |
--full | Prüft alle Änderungen, nicht nur die seit der letzten Prüfung des Branches. |
--dry-run | Listet die Dateien auf, die gesendet würden, und die, die auf Ihrem Rechner bleiben, ohne Anmeldung und ohne eine Prüfung zu starten. |
--json | Gibt die fertige Prüfung als JSON aus, für Skripte und Coding-Agents. |
Was auf Ihrem Rechner bleibt
Nur der Diff ab der Merge-Basis und Ihre Beschreibung verlassen Ihren Computer; den übrigen Code liest HeyDeer von GitHub. Diese Dateien lässt die CLI aus der Prüfung heraus und listet sie unter Left on this machine auf:
- Dateien mit Zugangsdaten, etwa .env-Dateien und private Schlüssel.
- Änderungen, die Zugangsdaten in einem bekannten Format enthalten.
- Binärdateien.
- Änderungen an einer Datei, die größer als 1 MB sind.
Alle Änderungen zusammen dürfen bis zu 32 MB Diff umfassen. Bei mehr übergeben Sie eine nähere --base oder prüfen die Änderungen in einem Pull Request. Mit --dry-run sehen Sie die genaue Liste, bevor etwas gesendet wird.
Nach dem Beheben erneut ausführen
Jede Prüfung eines Branches prüft die Befunde erneut, die die letzte Prüfung offen gelassen hat. Der nächste Lauf zeigt also, welche Ihr Fix behoben hat.
Ist im Repository Nur neue Änderungen prüfen aktiviert, umfasst eine spätere Prüfung des Branches nur, was sich seit der letzten vollständigen Prüfung geändert hat. Nach drei solchen Prüfungen, oder sobald die meisten Änderungen seit dieser Prüfung neu sind, umfasst die nächste wieder alle Änderungen. Mit --full prüfen Sie jederzeit alles. Hat sich seit der letzten Prüfung nichts geändert, meldet die CLI das und startet keine Prüfung.
Aus Skripten und Coding-Agents nutzen
Mit --json geht die fertige Prüfung als ein JSON-Objekt an die Standardausgabe und der Fortschritt an die Standardfehlerausgabe. Jeder Befund hat einen Schweregrad, einen Titel, Datei und Zeile sowie einen erklärenden Text.
Damit Claude Code, Codex oder Cursor die eigene Arbeit prüfen, bevor sie einen Pull Request öffnen, ergänzen Sie in AGENTS.md eine Anweisung wie diese:
Before opening a pull request, run `heydeer review --json "<what the change does>"`
from the repository root, fix the findings you agree with, and run it again.Die CLI endet mit einem dieser Codes:
| Exit-Code | Bedeutung |
|---|---|
| 0 | Die Prüfung ist fertig, mit oder ohne Befunde. |
| 1 | Die Prüfung ist fehlgeschlagen, oder jede geänderte Datei musste auf Ihrem Rechner bleiben. |
| 2 | Der Befehl oder seine Optionen waren ungültig. |
| 130 | Sie haben mit Strg+C abgebrochen. |
Eine fertige Prüfung endet mit 0, ob mit oder ohne Befunde. Ob ein Branch bereit ist, entscheiden Sie daher anhand der Befunde im JSON.
Credits
Eine lokale Prüfung nutzt die Credits des Arbeitsbereichs, dessen Installation das Repository umfasst, und wird in jedem Repository als privater Code abgerechnet. Ein Probelauf und ein Lauf ohne Änderungen seit der letzten Prüfung verbrauchen keine Credits. Jede Person kann bis zu 30 lokale Prüfungen pro Stunde starten. Strg+C bricht die Prüfung auch bei HeyDeer ab; zweimal gedrückt stoppt es die CLI sofort.