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.
Globale Flags
Abschnitt betitelt „Globale Flags“| Flag | Zweck |
|---|---|
--env NAME |
Die aktive Gateway-Umgebung für einen Befehl überschreiben. |
-v, --verbose |
Protokollieren Sie Metadaten von Anfragen und Antworten, wobei der Autorisierungsheader unkenntlich gemacht wird. |
--debug |
Fügen Sie der Diagnoseausgabe Anfrage- und Antworttexte hinzu. Gehen Sie bei sensiblen Daten vorsichtig vor. |
--json |
Geben Sie maschinenlesbares JSON aus, sofern dies unterstützt wird. |
--no-color |
Deaktivieren 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.
Authentifizierung
Abschnitt betitelt „Authentifizierung“| Befehl | Zweck |
|---|---|
champrep auth login |
Melden Sie sich über die Browser-Genehmigung an. |
champrep auth login --no-browser |
Drucken Sie eine Genehmigungs-URL für ein Remote-Terminal aus. |
champrep auth token |
Speichern Sie einen bereichsgebundenen APISchlüssel im Schlüsselbund des Betriebssystems. |
champrep auth whoami |
Zeigen Sie die aktive Identität und das Profil an. |
champrep auth status |
Identität, Live-Kontingent und verfügbaren Audit-Kontext anzeigen. |
champrep auth list |
Speicherte Profile über verschiedene Umgebungen hinweg auflisten. |
champrep auth switch PROFILE |
Wählen Sie ein anderes gespeichertes Profil für dasselbe Konto aus. |
champrep auth logout |
Den aktuellen lokalen Anmelde- und Profilstatus entfernen. |
| Befehl | Zweck |
|---|---|
champrep drive ls [REMOTE_PATH] |
Dateien in einem Ordner auflisten. |
champrep drive tree [REMOTE_PATH] |
Eine rekursive Ordnerstruktur anzeigen. |
champrep drive cp SOURCE DEST |
Eine Datei zwischen dem lokalen Computer und Drive. übertragen. |
champrep drive mv OLD NEW |
Ein ElementDrive verschieben oder umbenennen. |
champrep drive rm REMOTE_PATH |
Löschen Sie eine Datei oder einen Ordner. |
champrep drive mkdir REMOTE_PATH |
Erstellen Sie einen Ordner. |
champrep drive quota |
Den belegten und verfügbaren Speicherplatz anzeigen. |
Beispiele:
champrep drive ls /champrep drive tree /projectschamprep drive cp ./report.pdf /reports/report.pdfchamprep drive cp /reports/report.pdf ./report.pdfchamprep drive quota --json| Befehl | Zweck |
|---|---|
champrep mail ls |
Nachrichten in einem Postfachordner auflisten. |
champrep mail read MESSAGE_ID |
Eine Nachricht drucken. |
champrep mail send |
Senden Sie eine Nachricht unter Verwendung von Flags oder Eingabeaufforderungen. |
champrep mail accounts |
Verbundene Postfächer auflisten. |
champrep mail threads |
E-Mail-Threads auflisten. |
champrep mail domains |
Sichtbare 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.
| Befehl | Zweck |
|---|---|
champrep chat ls |
Räume auflisten. |
champrep chat read ROOM_ID |
Letzte Nachrichten lesen. |
champrep chat send ROOM_ID |
Eine Raumnachricht senden. |
champrep chat unread |
Die Anzahl der ungelesenen Nachrichten anzeigen. |
champrep chat create |
Einen Raum erstellen. |
Contacts
Abschnitt betitelt „Contacts“| Befehl | Zweck |
|---|---|
champrep contacts ls |
Kontakte auflisten. |
champrep contacts search QUERY |
Nach E-Mail-Adresse oder Name suchen. |
champrep contacts read CONTACT_ID |
Einen Kontakt anzeigen. |
champrep contacts labels |
Zeigen Sie Labels an. |
champrep contacts add USER_ID |
Einen Benutzer zu den Kontakten hinzufügen. |
champrep contacts update CONTACT_ID |
Aktualisieren Sie die Metadaten eines Kontakts. |
champrep contacts rm CONTACT_ID |
Einen Kontakt löschen. |
courses akzeptiert außerdem die learn Alias.
| Befehl | Zweck |
|---|---|
champrep courses ls |
Verfügbare Kurse auflisten. |
champrep courses enrolled |
Die Anmeldungen des aktiven Benutzers auflisten. |
champrep courses read COURSE_ID |
Einen Kurs anzeigen. |
champrep courses sections COURSE_ID |
Kursabschnitte auflisten. |
| Befehl | Zweck |
|---|---|
champrep notes ls |
Letzte Notizen auflisten. |
champrep notes create |
Eine Notiz erstellen. |
champrep notes read NOTE_ID |
Eine Notiz ausdrucken. |
champrep notes edit NOTE_ID |
Titel und/oder Text einer Notiz aktualisieren. |
champrep notes rm NOTE_ID |
Eine Notiz löschen. |
CHAMPREP AI
Abschnitt betitelt „CHAMPREP AI“| Befehl | Zweck |
|---|---|
champrep ai chat [PROMPT] |
Stellen Sie eine einmalige Frage oder starten Sie eine interaktive Sitzung. |
champrep ai summarize |
Eine Datei zusammenfassen. |
champrep ai conversations |
Gespeicherte Unterhaltungen auflisten. |
champrep ai read CONVERSATION_ID |
Eine Konversation lesen. |
champrep ai rm CONVERSATION_ID |
Eine Konversation löschen. |
champrep ai usage |
Aktuelle KI-Nutzung anzeigen. |
Überprüfen Sie wichtige KI-Ergebnisse, bevor Sie sich darauf verlassen.
| Befehl | Zweck |
|---|---|
champrep meet create |
Erstellen Sie einen Besprechungsraum. |
champrep meet ls |
Besprechungen auflisten. |
champrep meet join MEETING_ID |
Öffnen Sie eine Besprechung im Standardbrowser. |
Calendar
Abschnitt betitelt „Calendar“calendar akzeptiert außerdem die cal Alias.
| Befehl | Zweck |
|---|---|
champrep calendar today |
Zeigen Sie die heutigen Termine an. |
champrep calendar week |
Zeigen Sie die Termine dieser Woche an. |
champrep calendar create |
Erstellen Sie eine Veranstaltung. |
champrep calendar rm EVENT_ID |
Ein 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.
| Befehl | Zweck |
|---|---|
champrep search QUERY |
Durchsuchen Sie alle Ihre Dienste. |
champrep search services |
Zeigen Sie an, welche Dienste Sie durchsuchen können und ob die KI-Suche verfügbar ist. |
| Flag | Zweck |
|---|---|
-s, --service |
Beschränken Sie die Suche auf einen Dienst (wiederholbar). Dies hält die Abfrage kostengünstig. |
--limit |
Maximale Anzahl an Ergebnissen pro Dienst (Standard: 5, maximal 20). |
--ai |
Lassen Sie die Ergebnisse von der KI bewerten und erhalten Sie eine kurze Antwort. Verbraucht Ihre eigenen KI-Guthaben. |
champrep search "q3 roadmap"champrep search "invoice 1042" --service invoice --service mailchamprep search "what did we decide about pricing" --aiEine 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.
| Befehl | Zweck |
|---|---|
champrep work boards |
Listen Sie Ihre Boards auf. |
champrep work board BOARD_ID |
Ein Board anzeigen. |
champrep work tickets |
Tickets auflisten. Filtern nach --board, --status, --search, --mine. |
champrep work ticket TICKET |
Ein Ticket anhand der ID oder des Schlüssels anzeigen (zum Beispiel ENG-7). |
champrep work create |
Ein Ticket erstellen (--board, --title, --priority, --type). |
champrep work tickets --minechamprep work create --board 642f... --title "Fix login" --priority high --type bugInvoice
Abschnitt betitelt „Invoice“| Befehl | Zweck |
|---|---|
champrep invoice ls |
Rechnungen auflisten. Filtern nach --status. |
champrep invoice read INVOICE_ID |
Eine Rechnung anzeigen. |
champrep invoice issue INVOICE_ID |
Einen Entwurf ausstellen (vom Entwurf zum ausgestellten Dokument). |
champrep invoice send INVOICE_ID |
Eine Rechnung per E-Mail versenden (--to (wenn kein Empfänger hinterlegt ist). |
champrep invoice rm INVOICE_ID |
Einen 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.
| Befehl | Zweck |
|---|---|
champrep forms ls |
Listen Sie Ihre Formulare auf. |
champrep forms read FORM_ID |
Ein Formular anzeigen. |
champrep forms responses FORM_ID |
Die Antworten eines Formulars auflisten. |
champrep forms create |
Ein Formular erstellen (--title, --description, --publish). |
champrep forms publish FORM_ID |
Veröffentlichen Sie einen Formularentwurf. |
champrep forms rm FORM_ID |
Ein Formular in den Papierkorb verschieben. |
Organigramm
Abschnitt betitelt „Organigramm“| Befehl | Zweck |
|---|---|
champrep charts me |
Zeigen Sie Ihre Position im Organigramm an. |
champrep charts tree |
Das Organigramm als JSON ausgeben. |
champrep charts search QUERY |
Personen in der Organisation suchen. |
champrep charts profile USER_ID |
Das Profil einer Person als JSON ausgeben. |
Business
Abschnitt betitelt „Business“Verwaltung der Organisation (Enterprise). Lesezugriffe verwenden den business:read Gültigkeitsbereich.
| Befehl | Zweck |
|---|---|
champrep business info |
Zeigen Sie Ihre Organisation und Ihre Rolle darin an. |
champrep business members |
Mitglieder der Organisation auflisten. |
champrep business usage |
Zeigen Sie Nutzungsstatistiken der Organisation an. |
Konto und Nutzung
Abschnitt betitelt „Konto und Nutzung“| Befehl | Zweck |
|---|---|
champrep account |
Zeigen Sie Ihre Identität, Ihren Tarif sowie die aktuelle Rate-Limit-Auslastung, die tägliche Nutzung und die Speichernutzung an. |
champrep accountchamprep account --json
API Schlüssel
Abschnitt betitelt „API Schlüssel“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.
| Befehl | Zweck |
|---|---|
champrep keys ls |
Listen Sie Ihre SchlüsselAPI auf. |
champrep keys create |
Einen Schlüssel erstellen (--name, wiederholbar --scope, --expires-in-days, --allowed-ip). |
champrep keys get KEY_ID |
Zeigen Sie die Details eines Schlüssels an. |
champrep keys audit KEY_ID |
Das 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_ID |
Rotieren Sie das Geheimnis (das alte Geheimnis funktioniert nicht mehr). |
champrep keys revoke KEY_ID |
Einen Schlüssel löschen. |
champrep keys create --name "CI deploy" --scope drive:read --scope drive:writechamprep keys create --name "read-only" --scope '*' --expires-in-days 90
Abrechnung
Abschnitt betitelt „Abrechnung“Schreibgeschützte Ansicht Ihres Abonnements. Ändern Sie Tarife im Abrechnungs-Dashboard.
| Befehl | Zweck |
|---|---|
champrep billing subscription |
Zeigen Sie Ihr aktuelles Abonnement an (Alias sub). |
champrep billing cards |
Gespeicherte Zahlungsmethoden auflisten. |
champrep billing receipts |
Listen Sie frühere Belege auf. |
Webhooks
Abschnitt betitelt „Webhooks“Verwalten Sie ausgehende Webhook-Abonnements. Verwendet den webhooks:manage Gültigkeitsbereich.
| Befehl | Zweck |
|---|---|
champrep webhooks ls |
Listen Sie Ihre Webhooks auf. |
champrep webhooks events |
Listen Sie die Ereignistypen auf, die Sie abonnieren können. |
champrep webhooks create |
Erstellen Sie einen Webhook (--url, wiederholbar --event). Das Signaturgeheimnis wird einmalig angezeigt. |
champrep webhooks rotate WEBHOOK_ID |
Wechseln Sie das Signatur-Geheimnis. |
champrep webhooks rm WEBHOOK_ID |
Löschen Sie einen Webhook. |
Lokale Konfiguration und Tools
Abschnitt betitelt „Lokale Konfiguration und Tools“Für diese Befehle ist keine Serviceanfrage erforderlich, sofern in ihrem Hilfetext nicht anders angegeben ist.
| Befehl | Zweck |
|---|---|
champrep config get KEY |
Lesen Sie einen Konfigurationswert aus. |
champrep config set KEY VALUE |
Legen Sie einen zulässigen Konfigurationswert fest. |
champrep config list |
Geben Sie die aktuelle Konfiguration aus. |
champrep config path |
Geben Sie den Pfad zur Konfigurationsdatei aus. |
champrep config env [NAME] |
Zeigen Sie die Standardumgebung an oder legen Sie sie fest. |
champrep completion SHELL |
Erstellen Sie eine Vervollständigungsfunktion für Bash, Zsh, Fish oder PowerShell. |
champrep version |
Geben Sie Informationen zu Version, Commit, Erstellungsdatum und Laufzeit aus. |
Token werden nicht in der Konfigurationsdatei gespeichert. Versuchen Sie nicht, ein Authentifizierungstoken mit config set.
Exit-Codes
Abschnitt betitelt „Exit-Codes“| Code | Bedeutung |
|---|---|
0 |
Erfolg. |
1 |
Allgemeiner Fehler oder Fehler bei der Nutzung. |
3 |
Eine Authentifizierung ist erforderlich oder ungültig. |
4 |
Den Anmeldedaten fehlt der erforderliche Geltungsbereich. |
5 |
Ein aktuelles Gateway-Limit wurde erreicht. |
6 |
Netzwerkausfall. |
7 |
Ausfall des Gateways oder des Dienstes. |
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.
Ratenbegrenzungen
Abschnitt betitelt „Ratenbegrenzungen“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.