コンテンツにスキップ
Documentation

Runner Farm コマンド

champrep runner-farm、またはその短縮形 champrep rf、はターミナルから CHAMPREP Runner Farm を管理します:ファームのアカウント、コードホスト への接続、ランナープールとそのマシンのクラス、使用したクレジットと 分、およびファームが実行したジョブなどです。これは、通常の CLI サインインでユーザーとして動作するため、アカウント内の役割やプランは、 Runner Farm ウェブアプリとまったく同じように適用されます。

  1. インストールしてください。 CLI および ログイン で champrep auth login.
  2. ご利用のプランには「Runner Farm」が含まれている必要があり、ワークスペースにはファーム アカウントが必要です。Runner Farm Webアプリにてアカウントを作成し、接続を追加してください こちらから https://runners.champrep.com.

複数のファームアカウントで操作を行うことができます:ご自身のアカウント、組織のアカウント、または チームのアカウントなどです。それらを一覧表示し、その中から1つを選択して --workspace:

Terminal window
champrep rf accounts ls
champrep rf pools ls --workspace organization:65f0c0ffee0000000000abcd

--workspace は KEY 列の accounts ls: personal, organization:<id> または team:<id>。指定がない場合、ファームはウェブアプリと同様の方法でアカウントを選択します。 つまり、組織またはチームのアカウントが存在する場合はそちらを、 存在しない場合はご自身のアカウントを使用します。

コマンド目的
champrep rf accounts ls操作可能なワークスペース、ご自身の役割、および各ワークスペースにファームアカウントがあるかどうかを一覧表示します。
champrep rf accounts showファームアカウントを表示します:ステータス、請求先、同時実行可能なジョブ数、および月間クレジット上限。
champrep rf connections lsコードホストの接続を、その状態および実行中、保留中、プール内のジョブとともに一覧表示します。 --include-deleted, --limit (1-100).
champrep rf pools lsマシンクラス、使用中のスロット、待機中および保留中のジョブを含むプールを一覧表示します。 --connection ID, --state active|paused|draining|deleted, --search, --include-deleted, --limit (1-200).
champrep rf pools show POOL_ID1つのプール、その制限、タイムアウト、および現在のサイクルにおける数値を表示します。
champrep rf pools create接続にプールを追加します。これには --connection, --name および --class;また --isolation, --max-concurrent, --min-idle, --timeout.
champrep rf pools update POOL_ID変更 --name, --max-concurrent, --min-idle または --timeout、または --pause / --resume プール。
champrep rf usage現在の請求期間のクレジット(含まれる分、購入した分、使用した分、残高)および今月のマシンクラスごとの分数とクレジット、または --period YYYY-MM.
champrep rf jobs lsジョブを、待機中、保留中、および拒否されたものを含め、新しい順に一覧表示します。 --state running,held, --pool ID, --billed-to-me, --limit (1-200).

オプション値
--classcpu-2, cpu-4, cpu-8, arm64-2, arm64-4, build-4
--isolationshared_hardened (デフォルト)または tenant_dedicated
--max-concurrent同時に実行するジョブ数、0~500
--min-idle待機状態のジョブ数(0~50)
--timeoutジョブのタイムアウトは~から 15m ~ 6h、例: 90m または 2h

ご利用のプランによって、使用可能なクラス、分離レベル、および制限が決まります。 ダウングレード後にプランの上限を超えたプールは、次のように表示されます。 above plan in pools ls.

ジョブの実行場所やプールの稼働状況を確認するには:

Terminal window
champrep rf connections ls
champrep rf pools ls
champrep rf pools show pol_01HZX9K4

イメージビルド用のプールを追加し、メンテナンスのために一時停止するには:

Terminal window
champrep rf pools create --connection con_01HZX7 --name Builds \
--class build-4 --max-concurrent 4 --timeout 2h --yes
champrep rf pools update pol_01HZX9K4 --pause --yes
champrep rf pools update pol_01HZX9K4 --resume --max-concurrent 8 --yes

今月および先月の利用状況をご確認ください:

Terminal window
champrep rf usage
champrep rf usage --period 2026-10

待機中または保留中のジョブを検索するには:

Terminal window
champrep rf jobs ls --state waiting,held

pools create および pools update 何かを変更する前に確認を行います。回答してください y をターミナルで実行するか、引数として渡してください --yes (-y) をスクリプト内で使用します。ターミナルがなく、 かつ --yes このコマンドは拒否され、何も変更されません。 pools create には冪等性キーが含まれているため、ネットワークエラー後の CLI’s による自動再試行では、 2つのプールが追加されることはありません。

追加 --json Runner Farm から返された内容を出力します。 usage --json を出力します { "balance": …, "usage": …, "period": "YYYY-MM" }.

Terminal window
champrep rf pools ls --json | jq -r '.pools[] | "\(.id) \(.state) \(.busy)/\(.max_concurrent)"'

クレジットの数値は、役割に応じて表示されます。オーナーおよび請求管理者は常に表示されます。 管理者およびメンバーは、アカウントに自分宛てのクレジットがある場合にのみ表示されます。 非表示の数値は、次のように表示されます。 -.

安全上の理由から、 は、 認証情報を発行、置換、または検証するいかなる機能にもアクセスCLIできません。以下の操作を行うには、Runner Farm ウェブアプリをご利用ください:

  • ファームアカウントを作成するか、既存のアカウントを組織に移動します;
  • 接続の追加、自己管理型コードCHAMPREPのペアリング、またはランナー トークンもしくはコネクタのシークレットの置き換え;
  • 接続やプールの削除・復元、アカウントの閉鎖、および コストの可視性設定の変更を行います。

メッセージ対処方法
payment required … (INSUFFICIENT_CREDITS)残高では、このマシンクラスの料金を支払うことができません。クレジットを購入するか、次の期間までお待ちください。 は 請求CHAMPREP を推奨CLIしています。終了コード 1.
payment required … (PENDING_INVOICE), (WORKSPACE_NOT_BILLED)このアカウントには未払いの請求書があるか、プランの有効期限が切れています。オーナーまたは請求管理者が「請求CHAMPREP」で決済を行ってください。
needs your web session … (INTERACTIVE_SESSION_REQUIRED)Web アプリにログインしているご本人様のみが、この決定を行うことができます。以下の場所で実行してください。 https://runners.champrep.com.
not allowed for your role … (ROLE_REQUIRED)ワークスペースにおけるあなたの役割では、この変更を行う権限がありません。オーナーまたは管理者に確認してください。
not allowed for your role … (WORKSPACE_NOT_AVAILABLE)--workspace 指定されたワークスペースに所属していません。ご確認ください。 champrep rf accounts ls.
not available to your account …ご利用のプランには、ランナーファーム、このクラス、またはこの制限が含まれていません。
rate limited … (CAPACITY_EXHAUSTED)すべてのスロットが使用中です。しばらく待ってから再度お試しください。クレジットを購入しても状況は変わりません。このアカウントにそのようなプールや接続が存在しないか、ワークスペースにファームアカウントがまだ設定されていません。これらの拒否はコード で終了します。また、コード でも終了します。( )は で終了します。終了コードについてはこちらをご覧ください。CHAMPREP コードコマンド
not found …このアカウントにそのようなプールまたは接続が存在しないか、ワークスペースにファームアカウントがまだ設定されていません。

これらの拒否はコードで終了します 1、また --json. rate limited (CAPACITY_EXHAUSTED) は終了します 5;詳細は 終了コード.