Führen Sie den KI-Agenten im Headless-Modus und in der CI aus
Im Headless-Modus wird eine Eingabeaufforderung bis zum Abschluss ausgeführt, das Ergebnis ausgegeben und das Programm beendet. Es zeigt niemals eine Eingabeaufforderung an, daher müssen alle auszuführenden Schritte im Voraus festgelegt werden.
champrep ai -p "list the Go files here and count them"Lesen Sie die Eingabeaufforderung aus der Standardeingabe mit -p -:
git diff | champrep ai -p -
Standardmäßig schreibgeschützt
Abschnitt betitelt „Standardmäßig schreibgeschützt“Ohne zusätzliche Flags ist ein Headless-Lauf schreibgeschützt: Der Agent kann den Arbeitsbereich lesen und durchsuchen, kann jedoch keine Dateien bearbeiten oder Befehle ausführen. Alles, wofür eine Berechtigungsabfrage erforderlich wäre, wird abgelehnt, und dem Modell wird mitgeteilt, warum.
Erlauben Sie mit einem der beiden Flags weitere Optionen:
| Flag | Wirkung |
|---|---|
--allowed-tools RULES | Bestimmte Regeln nur für diesen Durchlauf vorab genehmigen. Aufrufe, die nicht durch eine Regel abgedeckt sind, werden abgelehnt. |
--permission-mode accept-edits | Dateibearbeitungen innerhalb des Arbeitsbereichs zulassen. Befehle benötigen weiterhin eine Zulassungsregel. |
champrep ai -p "fix the failing test" \ --allowed-tools "local_edit_file(src/**),local_bash(go test*)"Regeln verwenden die in
Zulassungs- und Sperrregeln. Trennen Sie die Regeln durch Kommas oder Leerzeichen oder wiederholen Sie das Flag. Wenn Sie eines der beiden Flags verwenden, gelten zusätzlich die Regeln in Ihrer Benutzereinstellungsdatei, und Ablehnungsregeln aus Projekteinstellungsdateien gelten immer. Zulassungsregeln aus Projekteinstellungsdateien sowie defaultMode aus beliebigen Einstellungsdateien werden bei Headless-Läufen nicht verwendet.
Aktionen, die Daten in Ihren CHAMPREPDiensten ändern, werden im Headless-Modus niemals genehmigt. Sie bleiben in der Warteschlange, und der Lauf gibt die Aktions-ID aus, damit Sie sie in der CHAMPREPWeb-App genehmigen oder ablehnen können.
Weitere Optionen
Abschnitt betitelt „Weitere Optionen“| Flag | Wirkung |
|---|---|
--output text | Standard. Das Ergebnis wird an die Standardausgabe ausgegeben; die Tool-Aktivitäten werden an die Standardfehlerausgabe ausgegeben. |
--output json | NDJSON-Ereignisse an die Standardausgabe streamen. --json hat denselben Effekt, wenn --output , ist nicht festgelegt. |
--max-turns N | Nach N Modelldurchläufen anhalten. Bei Erreichen des Limits wird der Lauf mit einer Fehlermeldung beendet. |
--model NAME | auto (Standard), eine Plattform-Modell-ID oder den Namen eines von Ihnen registrierten Modells. |
--add-dir PATH | Ein weiteres Verzeichnis zum Arbeitsbereich hinzufügen. Wiederholbar. |
--verbose | Geben Sie außerdem Statuszeilen in der Textausgabe aus. |
JSON-Ausgabe
Abschnitt betitelt „JSON-Ausgabe“Mit --output json: Jedes Ereignis besteht aus einem JSON-Objekt pro Zeile. Zu den Ereignissen gehören der gestreamte Antworttext, CHAMPREPTool-Aufrufe und -Ergebnisse sowie lokale Tool-Ereignisse (local_tool_start, local_tool_result, local_resume) sowie Genehmigungen. Die letzte Zeile lautet immer wie folgt:
{"type":"local_result","text":"There are 42 Go files.","conversation_id":"CONVERSATION_ID","suspensions":1,"model":"MODEL_ID","input_tokens":1234,"output_tokens":56}{"type":"local_error","code":"ERROR_CODE","message":"Explanation of the failure"}Analysieren Sie die letzte Zeile als Ergebnis und behandeln Sie andere Ereignistypen, die Sie nicht erkennen, als informative Meldungen.
Exit-Codes
Abschnitt betitelt „Exit-Codes“Ein erfolgreicher Durchlauf endet mit 0. Bei Fehlern wird der Standard
CLI Exit-Codes, zum Beispiel 3 wenn die Anmeldung fehlt oder ungültig ist und 5 wenn ein Limit erreicht wurde. Bei Ablehnungen wird ein Hinweis auf der Standardfehlerausgabe ausgegeben, z. B. bei einem Tarif, der den Agenten nicht umfasst, oder bei einem Minutenlimit mit der Anzahl der Sekunden, die gewartet werden müssen. Durch Drücken der Ctrl+C bricht den Lauf ab.
Verwenden Sie einen SchlüsselAPI in CI
Abschnitt betitelt „Verwenden Sie einen SchlüsselAPI in CI“-
Erstellen Sie einen Schlüssel, der Folgendes enthält:
ai:agentGültigkeitsbereich sowie die Gültigkeitsbereiche aller anderenchamprepBefehle, die der Job ausführt.ai:agentmüssen anhand des Namens ausgewählt werden; umfassendere Berechtigungsbereiche allein erlauben keine lokalen Tools.Terminal-Fenster champrep keys create --name "ci-review" --scope ai:agent -
Speichern Sie es als maskiertes, geschütztes CI-Geheimnis mit dem Namen
CHAMPREP_TOKEN. Er CLI nutzt diese direkt und benötigt keinen Schlüsselbund. -
Führen Sie den Agenten nur mit den Berechtigungen aus, die der Auftrag benötigt.
ai-review: script: - champrep ai -p "review the changes in this merge request and list problems by severity" --output json --max-turns 20 > review.ndjson - tail -n 1 review.ndjsonBefehle, die der Agent ausführt, erhalten niemals CHAMPREP_TOKEN oder jedes andere
CHAMPREP_* Variable. Um den Jobstatus vom Home-Verzeichnis Ihres Runners getrennt zu halten, legen Sie CHAMPREP_CONFIG_DIR in ein temporäres Verzeichnis.
Siehe API Schlüssel für die AutomatisierungCLI für die Rotation und Überprüfung sowie Tarife und Limits wie sich CI-Läufe auf Ihre Limits auswirken.