Runner-Farm-Befehle
champrep runner-farm, oder dessen Kurzform champrep rf, verwaltet die CHAMPREP Runner Farm von Ihrem Terminal aus: Ihre Farm-Konten, die Code-Host- Verbindungen, die Runner-Pools und deren Maschinenklassen, die von Ihnen genutzten Guthaben und Minuten sowie die von der Farm ausgeführten Aufträge. Es agiert in Ihrem Namen mit Ihrer normalen CLI Anmeldung, sodass Ihre Rolle im Konto und Ihr Tarif genau wie in der Runner Farm-Web-App gelten.
Bevor Sie beginnen
Abschnitt betitelt „Bevor Sie beginnen“- Installieren Sie die CLI und Anmelden mit
champrep auth login. - Ihr Tarif muss „Runner Farm“ enthalten, und der Arbeitsbereich benötigt ein Farm-Konto. Erstellen Sie das Konto und fügen Sie Verbindungen in der Runner Farm-Web-App hinzu unter
https://runners.champrep.com.
Welches Farm-Konto
Abschnitt betitelt „Welches Farm-Konto“Sie können in mehr als einem Farm-Konto agieren: in Ihrem eigenen sowie in dem einer Organisation oder eines Teams. Listen Sie diese auf und wählen Sie anschließend eines aus mit --workspace:
champrep rf accounts lschamprep rf pools ls --workspace organization:65f0c0ffee0000000000abcd--workspace nimmt den KEY Spalte von accounts ls: personal,
organization:<id> oder team:<id>. Ohne diese Angabe wählt die Farm das Konto auf dieselbe Weise aus wie die Web-App: das Konto Ihrer Organisation oder Ihres Teams, sofern ein solches vorhanden ist, ansonsten Ihr eigenes.
Befehle
Abschnitt betitelt „Befehle“| Befehl | Zweck |
|---|---|
champrep rf accounts ls | Listen Sie die Arbeitsbereiche auf, in denen Sie tätig sein können, Ihre Rolle sowie angeben, ob jeder über ein Farm-Konto verfügt. |
champrep rf accounts show | Zeigen Sie das Farm-Konto an: Status, Rechnungsempfänger, Aufträge gleichzeitig und das monatliche Guthabenlimit. |
champrep rf connections ls | Listen Sie die Code-Host-Verbindungen mit ihrem Status sowie die laufenden, zurückgestellten und im Pool befindlichen Aufträge auf. --include-deleted, --limit (1-100). |
champrep rf pools ls | Listen Sie Pools mit Maschinenklasse, belegten Slots sowie wartenden und zurückgestellten Aufträgen auf. --connection ID, --state active|paused|draining|deleted, --search, --include-deleted, --limit (1-200). |
champrep rf pools show POOL_ID | Einen Pool, dessen Limits, Zeitlimit und Zahlen für den aktuellen Zyklus anzeigen. |
champrep rf pools create | Fügen Sie einer Verbindung einen Pool hinzu. Erfordert --connection, --name und --class; außerdem --isolation, --max-concurrent, --min-idle, --timeout. |
champrep rf pools update POOL_ID | Ändern --name, --max-concurrent, --min-idle oder --timeout, oder --pause / --resume den Pool. |
champrep rf usage | Guthaben für den aktuellen Abrechnungszeitraum (inbegriffen, gekauft, verbraucht, verbleibend) sowie Minuten und Guthaben pro Maschinenklasse für diesen Monat oder --period YYYY-MM. |
champrep rf jobs ls | Aufträge auflisten, beginnend mit den neuesten, einschließlich wartender, zurückgestellter und abgelehnter Aufträge. --state running,held, --pool ID, --billed-to-me, --limit (1-200). |
Maschinenklassen und Grenzwerte
Abschnitt betitelt „Maschinenklassen und Grenzwerte“| Option | Werte |
|---|---|
--class | cpu-2, cpu-4, cpu-8, arm64-2, arm64-4, build-4 |
--isolation | shared_hardened (Standard) oder tenant_dedicated |
--max-concurrent | Aufträge gleichzeitig, 0 bis 500 |
--min-idle | Warmläufer, die in Bereitschaft gehalten werden: 0 bis 50 |
--timeout | Auftrags-Timeout von 15m bis 6h, zum Beispiel 90m oder 2h |
Ihr Tarif bestimmt, welche Klassen, Isolationsstufen und Limits Sie nutzen dürfen. Ein Pool, der nach einer Herabstufung die Tarifgrenzen überschritten hat, zeigt above plan in
pools ls.
Beispiele
Abschnitt betitelt „Beispiele“Sehen Sie nach, wo Ihre Jobs ausgeführt werden und wie ausgelastet die Pools sind:
champrep rf connections lschamprep rf pools lschamprep rf pools show pol_01HZX9K4Fügen Sie einen Pool für Image-Builds hinzu und halten Sie ihn für Wartungsarbeiten an:
champrep rf pools create --connection con_01HZX7 --name Builds \ --class build-4 --max-concurrent 4 --timeout 2h --yeschamprep rf pools update pol_01HZX9K4 --pause --yeschamprep rf pools update pol_01HZX9K4 --resume --max-concurrent 8 --yesÜberprüfen Sie, was Sie in diesem Zeitraum und im letzten Monat genutzt haben:
champrep rf usagechamprep rf usage --period 2026-10Suchen Sie nach Jobs, die warten oder zurückgestellt sind:
champrep rf jobs ls --state waiting,held
Bestätigung und Skripterstellung
Abschnitt betitelt „Bestätigung und Skripterstellung“pools create und pools update fragen, bevor sie etwas ändern. Antworten Sie y
auf einem Terminal oder übergeben Sie --yes (-y) in einem Skript. Ohne Terminal und ohne --yes Der Befehl wird abgelehnt und nimmt keine Änderungen vor. pools create
enthält einen Idempotenzschlüssel, sodass CLIder automatische Wiederholungsversuch nach einem Netzwerkfehler niemals zwei Pools zusammenführt.
Hinzufügen --json um die von Runner Farm zurückgegebenen Daten auszugeben. usage --json gibt aus
{ "balance": …, "usage": …, "period": "YYYY-MM" }.
champrep rf pools ls --json | jq -r '.pools[] | "\(.id) \(.state) \(.busy)/\(.max_concurrent)"'Die Guthabenangaben richten sich nach Ihrer Rolle: Eigentümer und Abrechnungsmanager sehen sie immer; Administratoren und Mitglieder sehen sie nur, wenn das Konto ihnen Guthaben anzeigt. Ausgeblendete Zahlen werden als -.
Was in der Web-App verbleibt
Abschnitt betitelt „Was in der Web-App verbleibt“Aus Sicherheitsgründen kann der CLI keinen Zugriff auf Funktionen erhalten, die eine Anmeldeinformation ausstellen, ersetzen oder prüfen. Verwenden Sie die Runner-Farm-Webanwendung, um:
- Erstellen Sie ein Farm-Konto oder verschieben Sie eines in eine Organisation;
- fügen Sie eine Verbindung hinzu, koppeln Sie einen selbstverwalteten CHAMPREPCode oder ersetzen Sie ein Runner-Token oder ein Connector-Geheimnis;
- löschen oder stellen Verbindungen und Pools wieder her, schließen das Konto und ändern die Einstellung zur Kostensichtbarkeit.
Mögliche Fehlermeldungen
Abschnitt betitelt „Mögliche Fehlermeldungen“| Meldung | Was ist zu tun? |
|---|---|
payment required … (INSUFFICIENT_CREDITS) | Das Guthaben reicht nicht aus, um die Maschinenklasse zu bezahlen. Kaufen Sie Credits oder warten Sie bis zum nächsten Abrechnungszeitraum; der CLI empfiehlt CHAMPREP Abrechnung. Beendigungscode 1. |
payment required … (PENDING_INVOICE), (WORKSPACE_NOT_BILLED) | Für das Konto liegt eine unbezahlte Rechnung vor oder der Tarif ist abgelaufen. Ein Eigentümer oder Abrechnungsmanager begleicht dies unter „AbrechnungCHAMPREP“. |
needs your web session … (INTERACTIVE_SESSION_REQUIRED) | Nur Sie, die in der Web-App angemeldet sind, können diese Entscheidung treffen. Führen Sie dies unter https://runners.champrep.com. |
not allowed for your role … (ROLE_REQUIRED) | Ihre Rolle im Arbeitsbereich erlaubt diese Änderung nicht. Wenden Sie sich an einen Eigentümer oder Administrator. |
not allowed for your role … (WORKSPACE_NOT_AVAILABLE) | --workspace bezeichnet einen Arbeitsbereich, in dem Sie sich nicht befinden. Bitte überprüfen Sie dies. champrep rf accounts ls. |
not available to your account … | Ihr Tarif umfasst weder Runner Farm noch diese Klasse oder dieses Limit. |
rate limited … (CAPACITY_EXHAUSTED) | Jeder Slot ist belegt. Bitte warten Sie und versuchen Sie es erneut; der Kauf von Credits hilft nicht. |
not found … | In diesem Konto gibt es keinen solchen Pool oder keine solche Verbindung, oder der Arbeitsbereich verfügt noch über kein Farm-Konto. |
Diese Ablehnungen enden mit dem Code 1, auch mit --json. rate limited
(CAPACITY_EXHAUSTED) beendet den Vorgang 5; siehe die
Beendigungscodes.