Zum Inhalt springen
Documentation

CLI Befehlsreferenz

Ausführen champrep --help und champrep COMMAND --help für die genauen Flags, die von der installierten Version bereitgestellt werden. Diese Seite fasst die aktuelle öffentliche Befehlsstruktur zusammen.

FlagZweck
--env NAMEDie aktive Gateway-Umgebung für einen Befehl überschreiben.
--profile IDVerwenden Sie für einen Befehl ein anderes gespeichertes Konto, ohne das aktive Konto zu ändern.
-v, --verboseProtokollieren Sie Metadaten von Anfragen und Antworten, wobei der Autorisierungsheader unkenntlich gemacht wird.
--debugFügen Sie der Diagnoseausgabe Anfrage- und Antworttexte hinzu. Gehen Sie bei sensiblen Daten vorsichtig vor.
--jsonGeben Sie maschinenlesbares JSON aus, sofern dies unterstützt wird.
--no-colorDeaktivieren Sie ANSI-Farben. Das Skript berücksichtigt CLIaußerdem NO_COLOR.

Platzieren Sie dauerhafte Flags vor oder nach einem Unterbefehl, wie es von der installierten Version unterstützt wird. Bevorzugen Sie --json für die Automatisierung.

BefehlZweck
champrep auth loginMelden Sie sich über die Browser-Genehmigung an.
champrep auth login --no-browserDrucken Sie eine Genehmigungs-URL für ein Remote-Terminal aus.
champrep auth tokenSpeichern Sie einen bereichsgebundenen APISchlüssel im Schlüsselbund des Betriebssystems.
champrep auth whoamiZeigen Sie die aktive Identität und das Profil an.
champrep auth statusIdentität, Live-Kontingent und verfügbaren Audit-Kontext anzeigen.
champrep auth listSpeicherte Profile über verschiedene Umgebungen hinweg auflisten.
champrep auth switch PROFILEWählen Sie ein anderes gespeichertes Profil für dasselbe Konto aus.
champrep auth logoutDen aktuellen lokalen Anmelde- und Profilstatus entfernen.
BefehlZweck
champrep drive ls [REMOTE_PATH]Dateien in einem Ordner auflisten.
champrep drive tree [REMOTE_PATH]Eine rekursive Ordnerstruktur anzeigen.
champrep drive cp SOURCE DESTEine Datei zwischen dem lokalen Computer und Drive. übertragen.
champrep drive mv OLD NEWEin ElementDrive verschieben oder umbenennen.
champrep drive rm REMOTE_PATHLöschen Sie eine Datei oder einen Ordner.
champrep drive mkdir REMOTE_PATHErstellen Sie einen Ordner.
champrep drive quotaDen belegten und verfügbaren Speicherplatz anzeigen.

Beispiele:

Terminal-Fenster
champrep drive ls /
champrep drive tree /projects
champrep drive cp ./report.pdf /reports/report.pdf
champrep drive cp /reports/report.pdf ./report.pdf
champrep drive quota --json
BefehlZweck
champrep mail lsNachrichten in einem Postfachordner auflisten.
champrep mail read MESSAGE_IDEine Nachricht drucken.
champrep mail sendSenden Sie eine Nachricht. --subject ist erforderlich; um ohne dieses Element zu senden, lassen Sie es weg und übergeben Sie --no-subject.
champrep mail accountsVerbundene Postfächer auflisten.
champrep mail threadsE-Mail-Threads auflisten.
champrep mail domainsSichtbare E-Mail-Domänen auflisten.

Verwenden champrep mail send --help vor dem Erstellen eines Sende-Skripts, damit die Flags für Empfänger, Betreff, Text und Anhang der installierten Version korrekt verarbeitet werden.

BefehlZweck
champrep chat lsRäume auflisten.
champrep chat read ROOM_IDLetzte Nachrichten lesen.
champrep chat send ROOM_IDEine Raumnachricht senden.
champrep chat unreadDie Anzahl der ungelesenen Nachrichten anzeigen.
champrep chat createEinen Raum erstellen.
BefehlZweck
champrep contacts lsKontakte auflisten.
champrep contacts search QUERYNach E-Mail-Adresse oder Name suchen.
champrep contacts read CONTACT_IDEinen Kontakt anzeigen.
champrep contacts labelsZeigen Sie Labels an.
champrep contacts add USER_IDEinen Benutzer zu den Kontakten hinzufügen.
champrep contacts update CONTACT_IDAktualisieren Sie die Metadaten eines Kontakts.
champrep contacts rm CONTACT_IDEinen Kontakt löschen.

courses akzeptiert außerdem die learn Alias.

BefehlZweck
champrep courses lsVerfügbare Kurse auflisten.
champrep courses enrolledDie Anmeldungen des aktiven Benutzers auflisten.
champrep courses read COURSE_IDEinen Kurs anzeigen.
champrep courses sections COURSE_IDKursabschnitte auflisten.
BefehlZweck
champrep notes lsLetzte Notizen auflisten.
champrep notes createEine Notiz erstellen.
champrep notes read NOTE_IDEine Notiz ausdrucken.
champrep notes edit NOTE_IDTitel und/oder Text einer Notiz aktualisieren.
champrep notes rm NOTE_IDVerschieben Sie eine Notiz in den Papierkorb. Stellen Sie sie innerhalbCHAMPREPNotes von 30 Tagen wieder her; danach wird sie automatisch gelöscht. Eine Notiz im Papierkorb kann gelesen, aber nicht bearbeitet werden.
BefehlZweck
eve oder champrep aiStarten Sie den interaktiven KI-Agenten „Eve“ für das Paarprogrammieren im aktuellen Verzeichnis.
champrep eveAlias für champrep ai / eve.
eve -p PROMPT oder champrep ai -p PROMPTFühren Sie den Agenten im Headless-Modus für eine Eingabeaufforderung aus und geben Sie die Antwort aus.
champrep ai models lsListen Sie Plattformmodelle und Modelle auf, die Sie mit Ihrem eigenen Schlüssel registriert haben.
champrep ai models registerRegistrieren Sie ein Modell, das Ihren eigenen Anbieter-SchlüsselAPI verwendet.
champrep ai models rm NAMEEntfernen Sie ein registriertes Modell und dessen Schlüssel.
champrep ai pathsZeigen Sie alle lokalen Dateien und Ordner an, die der Agent verwendet.
champrep ai chat [PROMPT]Stellen Sie eine einmalige Frage oder starten Sie eine interaktive Sitzung.
champrep ai summarizeEine Datei zusammenfassen.
champrep ai conversationsGespeicherte Unterhaltungen auflisten.
champrep ai read CONVERSATION_IDEine Konversation lesen.
champrep ai rm CONVERSATION_IDEine Konversation löschen.
champrep ai usageAktuelle KI-Nutzung anzeigen.

Überprüfen Sie wichtige KI-Ergebnisse, bevor Sie sich darauf verlassen.

Informationen zu den Slash-Befehlen, Berechtigungen und Optionen des Agenten finden Sie unter KI-Agent: Eve (champrep ai / eve).

BefehlZweck
champrep meet createErstellen Sie einen Besprechungsraum.
champrep meet lsBesprechungen auflisten.
champrep meet join MEETING_IDÖffnen Sie eine Besprechung im Standardbrowser.

calendar akzeptiert außerdem die cal Alias.

BefehlZweck
champrep calendar todayZeigen Sie die heutigen Termine an.
champrep calendar weekZeigen Sie die Termine dieser Woche an.
champrep calendar createErstellen Sie eine Veranstaltung.
champrep calendar rm EVENT_IDEin Ereignis löschen.

Durchsuchen Sie alles, worauf Ihre Zugangsdaten Zugriff haben, in einer einzigen Abfrage. Die Ergebnisse werden nach Dienst gruppiert, und alles, was übersprungen wurde, wird mit dem Grund dafür aufgelistet.

BefehlZweck
champrep search QUERYDurchsuchen Sie alle Ihre Dienste.
champrep search servicesZeigen Sie an, welche Dienste Sie durchsuchen können und ob die KI-Suche verfügbar ist.
FlagZweck
-s, --serviceBeschränken Sie die Suche auf einen Dienst (wiederholbar). Dies hält die Abfrage kostengünstig.
--limitMaximale Anzahl an Ergebnissen pro Dienst (Standard: 5, maximal 20).
--aiLassen Sie die Ergebnisse von der KI bewerten und erhalten Sie eine kurze Antwort. Verbraucht Ihre eigenen KI-Guthaben.
Terminal-Fenster
champrep search "q3 roadmap"
champrep search "invoice 1042" --service invoice --service mail
champrep search "what did we decide about pricing" --ai

Eine Suche kostet eine Rate-Limit-Einheit pro tatsächlich durchsuchtem Dienst; daher ist die Eingrenzung mit --service ist der kostengünstigste Weg, um die Reaktionsfähigkeit zu gewährleisten. --ai verbraucht Ihre monatlichen KI-Guthaben; ohne Guthaben liefert der Befehl weiterhin normale Ergebnisse und teilt Ihnen mit, warum die KI-Rangliste nicht ausgeführt wurde.

BefehlZweck
champrep work boardsListen Sie Ihre Boards auf.
champrep work board BOARD_IDEin Board anzeigen.
champrep work ticketsTickets auflisten. Filtern nach --board, --status (eine Status-ID oder mit --board ein Statusname), --search, --mine; --limit 1 bis 200.
champrep work ticket TICKETEin Ticket anhand der ID oder des Schlüssels anzeigen (zum Beispiel ENG-7).
champrep work createEin Ticket erstellen (--board, --title, --priority, --type).
Terminal-Fenster
champrep work tickets --mine
champrep work create --board 642f... --title "Fix login" --priority high --type bug
BefehlZweck
champrep invoice lsRechnungen auflisten. Filtern nach --status.
champrep invoice read INVOICE_IDEine Rechnung anzeigen.
champrep invoice issue INVOICE_IDEinen Entwurf ausstellen (vom Entwurf zum ausgestellten Dokument).
champrep invoice send INVOICE_IDEine Rechnung per E-Mail versenden (--to (wenn kein Empfänger hinterlegt ist).
champrep invoice rm INVOICE_IDEinen Entwurf löschen.

Das Erstellen und Versenden verbraucht das Kontingent für den Rechnungsversand Ihres Tarifs, daher ist hierfür die invoice:send Berechtigung für einen API-SchlüsselAPI.

BefehlZweck
champrep forms lsListen Sie Ihre Formulare auf.
champrep forms read FORM_IDEin Formular anzeigen.
champrep forms responses FORM_IDDie Antworten eines Formulars auflisten.
champrep forms createEin Formular erstellen (--title, --description, --publish).
champrep forms publish FORM_IDVeröffentlichen Sie einen Formularentwurf.
champrep forms rm FORM_IDEin Formular in den Papierkorb verschieben.

BefehlZweck
champrep charts meZeigen Sie Ihre Position im Organigramm an.
champrep charts treeDas Organigramm als JSON ausgeben.
champrep charts search QUERYPersonen in der Organisation suchen.
champrep charts profile USER_IDDas Profil einer Person als JSON ausgeben.

Verwaltung der Organisation (Enterprise). Lesezugriffe verwenden den business:read Gültigkeitsbereich.

BefehlZweck
champrep business infoZeigen Sie Ihre Organisation und Ihre Rolle darin an.
champrep business membersMitglieder der Organisation auflisten.
champrep business usageZeigen Sie Nutzungsstatistiken der Organisation an.

Projekte, Zweige, Merge-Anfragen, Issues, Pipelines, Job-Protokolle und Releases. PROJECT ist der vollständige Pfad des Projekts (acme/web) oder dessen ID. Vollständige Referenz: CHAMPREP Code-Befehle.

BefehlZweck
champrep code projects ls / show / createProjekte auflisten, anzeigen und erstellen.
champrep code repo clone-url PROJECTDie Klonadresse ausgeben (--ssh (für SSH).
champrep code cloneProjekte und eine Gruppe klonen (--group, --include-subgroups) oder Ihre eigenen (--membership, --owned, --all) in einen Namensraumbaum; --update hält die Seite auf dem neuesten Stand.
champrep code branches ls PROJECTZweige auflisten.
champrep code mr ls / show / create / merge / approveWork mit Merge-Anfragen.
champrep code issues ls / show / create / close / reopenWork mit Problemen.
champrep code pipelines ls / show / run / retry / cancelWork mit Pipelines.
champrep code pipelines wait PROJECT [ID]Warten Sie auf eine Pipeline, die aktuellste eines Commits (--sha), oder die neueste Version unter --ref um den Vorgang zu beenden; beendet das Programm 0 Bei Erfolg, 1 Andernfalls, 8 auf --timeout.
champrep code jobs ls / log / play / retryAuflistung von Aufträgen, Ausdrucken oder Verfolgen (--follow) ein Protokoll anzeigen, manuelle Aufträge starten.
champrep code releases ls PROJECTAuflistung von Releases.
champrep code runners ls / show / update / createListen Sie Runner auf und sehen Sie, wer online ist, ändern Sie Tags, pausieren und setzen Sie den Lauf fort, erstellen Sie einen Runner.
champrep code ssh-keys lsListen Sie Ihre SSH-Schlüssel für Git über SSH auf.
Terminal-Fenster
champrep code clone --group acme --include-subgroups --dest ~/src --ssh
champrep code mr ls acme/web
champrep code pipelines run acme/web --ref main --yes
champrep code jobs log acme/web 4182 --follow

Aufschlüsselte Anleitungen für Code, Runner Farm und QA, einschließlich der Verwendung in der kontinuierlichen Integration (CI), finden Sie unter Häufige Aufgaben.

runner-farm akzeptiert außerdem die rf Alias. --workspace Wählt das Farm- Konto aus (personal, organization:<id>, team:<id>). Vollständige Referenz: Befehle für die Runner-Farm.

BefehlZweck
champrep rf accounts ls / showListen Sie die Farm-Konten auf, in denen Sie agieren können; zeigen Sie eines an.
champrep rf connections lsCode-Host-Verbindungen auflisten.
champrep rf pools ls / show / create / updateVerwalten Sie Runner-Pools, einschließlich --pause und --resume.
champrep rf usageGuthaben und Minuten für den aktuellen Zeitraum.
champrep rf jobs lsAuflistung von Aufträgen, einschließlich wartender und zurückgestellter Aufträge.
Terminal-Fenster
champrep rf pools ls
champrep rf usage

Repositorys, Scans, Befunde, Qualitätskontrollen, Vorschauen und IDE-Arbeitsbereiche. REPO ist ein Repository-Schlüssel, z. B. code:<project-uuid>. Vollständige Referenz: CHAMPREP QA Befehle.

BefehlZweck
champrep qa repos ls / available / activate / deactivate / syncVerwalten Sie die QA-Analysen der Repositories.
champrep qa scan REPOEinen Scan starten; --watch verfolgt diesen bis zum Ende.
champrep qa scans ls / showScans auflisten und anzeigen.
champrep qa findings ls / show / dismiss / reopenFilter (--severity, --cwe, --branch, --state) und die Ergebnisse zu bewerten.
champrep qa gates status REPOZeigt das Ergebnis des Qualitäts-Gates an; beendet das Programm 1 , wenn ein Fehler auftritt.
champrep qa previews ls / show / create / extend / stopVerwalten Sie Vorschauumgebungen.
champrep qa ide ls / start / open / stopCloud-IDE-Arbeitsbereiche verwalten.
Terminal-Fenster
champrep qa scan code:7d0c5c6e-0b6a-4e2b-9a55-0f8e6c1d2a10 --watch --yes
champrep qa findings ls --severity critical,high

In diesen drei Gruppen fragen Befehle, die Änderungen vornehmen oder CI-Minuten, Credits oder Kontingente verbrauchen, zunächst ab: code mr create, mr merge, mr approve, issues close und reopen, bei jeder Pipeline- und Job-Aktion, rf pools create und update, und jedes qa Schreiben (repos activate und deactivate, scan, findings dismiss und reopen, previews create, extend und stop, ide start und stop). Übergeben --yes (-y) in Skripten; ohne Terminal und ohne --yes, sie ändern nichts. Beim Erstellen eines Code-Projekts oder eines Issues werden keine Abfragen gestellt. --workspace auf rf und qa wählt das Konto aus, das verwendet und abgerechnet wird.

BefehlZweck
champrep accountZeigen Sie Ihre Identität, Ihren Tarif sowie die aktuelle Rate-Limit-Auslastung, die tägliche Nutzung und die Speichernutzung an.
Terminal-Fenster
champrep account
champrep account --json

Verwalten Sie die cpk_... Schlüssel, die für den Headless- und CI-Zugriff verwendet werden. Diese Befehle erfordern eine interaktive Browsersitzung (ausführen champrep auth login „first“, nicht auth token). Beim Erstellen oder Rotieren eines Schlüssels wird das Geheimnis einmalig ausgegeben.

BefehlZweck
champrep keys lsListen Sie Ihre SchlüsselAPI auf.
champrep keys createEinen Schlüssel erstellen (--name, wiederholbar --scope, --expires-in-days, --allowed-ip).
champrep keys get KEY_IDZeigen Sie die Details eines Schlüssels an.
champrep keys audit KEY_IDDas aktuelle Audit-Protokoll eines Schlüssels anzeigen.
champrep keys update KEY_IDÄndern Sie den Namen, die Gültigkeitsbereiche, die IP-Zulassungsliste oder --active/--inactive.
champrep keys regenerate KEY_IDRotieren Sie das Geheimnis (das alte Geheimnis funktioniert nicht mehr).
champrep keys revoke KEY_IDEinen Schlüssel löschen.
Terminal-Fenster
champrep keys create --name "CI deploy" --scope drive:read --scope drive:write
champrep keys create --name "read-only" --scope '*' --expires-in-days 90

Schreibgeschützte Ansicht Ihres Abonnements. Ändern Sie Tarife im Abrechnungs-Dashboard.

BefehlZweck
champrep billing subscriptionZeigen Sie Ihr aktuelles Abonnement an (Alias sub).
champrep billing cardsGespeicherte Zahlungsmethoden auflisten.
champrep billing receiptsListen Sie frühere Belege auf.

Verwalten Sie ausgehende Webhook-Abonnements. Verwendet den webhooks:manage Gültigkeitsbereich.

BefehlZweck
champrep webhooks lsListen Sie Ihre Webhooks auf.
champrep webhooks eventsListen Sie die Ereignistypen auf, die Sie abonnieren können.
champrep webhooks createErstellen Sie einen Webhook (--url, wiederholbar --event). Das Signaturgeheimnis wird einmalig angezeigt.
champrep webhooks rotate WEBHOOK_IDWechseln Sie das Signatur-Geheimnis.
champrep webhooks rm WEBHOOK_IDLöschen Sie einen Webhook.

Für diese Befehle ist keine Serviceanfrage erforderlich, sofern in ihrem Hilfetext nicht anders angegeben ist.

BefehlZweck
champrep config get KEYLesen Sie einen Konfigurationswert aus.
champrep config set KEY VALUELegen Sie einen zulässigen Konfigurationswert fest. Ein api_url oder web_url muss ein https:// Adresse.
champrep config listDrucken Sie die aktuelle Konfiguration aus. Mit --json Die Schlüssel gehören zur Datei selbst (default_environment, api_url …).
champrep config pathGeben Sie den Pfad zur Konfigurationsdatei aus.
champrep config env [NAME]Zeigen Sie die Standardumgebung an oder legen Sie sie fest.
champrep completion SHELLErstellen Sie eine Vervollständigungsfunktion für Bash, Zsh, Fish oder PowerShell.
champrep versionGeben Sie Informationen zu Version, Commit, Erstellungsdatum und Laufzeit aus.

Token werden nicht in der Konfigurationsdatei gespeichert. Versuchen Sie nicht, ein Authentifizierungstoken mit config set.

CodeBedeutung
0Erfolg.
1Allgemeiner Fehler oder Nutzungsfehler oder eine Ablehnung, die sich durch erneutes Anmelden nicht beheben lässt: kein Zugriff auf das Element, nicht in Ihrem Tarif enthalten, Zahlung oder Guthaben erforderlich, Ihre Rolle oder eine Entscheidung, die Ihre Websitzung erfordert.
3Eine Authentifizierung ist erforderlich oder ungültig.
4Den Anmeldedaten fehlt der erforderliche Geltungsbereich.
5Ein aktuelles Gateway-Limit wurde erreicht.
6Netzwerkausfall.
7Ausfall des Gateways oder des Dienstes.
8Eine Wartezeit ist abgelaufen: code pipelines wait --timeout.

Skripte sollten den Beendigungscode überprüfen und die Ausgabe auswerten --json Ausgabe, sobald diese verfügbar ist. Verwenden Sie für Menschen lesbare Fehlermeldungen nicht als stabile Schnittstelle.

Jede Gateway-Antwort enthält Ihre aktuellen Limits. Die führt transparentCLI Wiederholungsversuche bei einem kurzen Minutenlimit durch und beachtet dabei Retry-After. Dies geschieht nicht Sie wartet nicht auf ein Tageslimit oder eine Wartezeit von mehr als einigen Sekunden – stattdessen beendet sie sich mit dem Code 5 und meldet die genaue Wartezeit, sodass Skripte frühzeitig fehlschlagen. Überprüfen Sie Ihre aktuellen Zähler jederzeit mit champrep account.