コンテンツにスキップ
Documentation

CLI コマンドリファレンス

実行 champrep --help および champrep COMMAND --help インストール済みのバージョンに同梱されている 正確なフラグについては、こちらのページで現在の公開コマンドツリーをまとめています。

フラグ目的
--env NAME1つのコマンドについて、アクティブなGateway環境を上書きします。
--profile IDアクティブなアカウントを変更せずに、1つのコマンドに対して別の保存済みアカウントを使用します。
-v, --verbose認証ヘッダーを伏せた状態で、リクエストおよびレスポンスのメタデータをログに記録します。
--debug診断出力にリクエストおよびレスポンスの本文を追加します。機密データを取り扱う際は慎重にご利用ください。
--jsonサポートされている場合は、機械可読なJSONを出力します。
--no-colorANSI カラーを無効にします。またCLI、 NO_COLOR.

インストール済みのバージョンでサポートされている形式に従い、サブコマンドの前または後に永続的なフラグを配置します。 優先 --json 自動化のため。

コマンド目的
champrep auth loginブラウザの承認を通じてサインインします。
champrep auth login --no-browserリモート端末用の承認URLを印刷します。
champrep auth tokenスコープ付きキーAPIをOSのキーチェーンに保存します。
champrep auth whoamiアクティブな ID およびプロファイルを表示します。
champrep auth statusID、リアルタイムのクォータ、および利用可能な監査コンテキストを表示します。
champrep auth list環境全体で保存されているプロファイルを一覧表示します。
champrep auth switch PROFILE同じアカウントに対して、別の保存済みプロファイルを選択します。
champrep auth logout現在のローカル認証情報とプロファイルの状態を削除します。
コマンド目的
champrep drive ls [REMOTE_PATH]フォルダ内のファイルを一覧表示します。
champrep drive tree [REMOTE_PATH]再帰的なフォルダツリーを表示します。
champrep drive cp SOURCE DESTローカルマシンと . 間でファイルを転送しますDrive。
champrep drive mv OLD NEW項目Driveを移動または名前変更します。
champrep drive rm REMOTE_PATHファイルまたはフォルダを削除します。
champrep drive mkdir REMOTE_PATHフォルダを作成します。
champrep drive quota使用済みおよび空きストレージを表示します。

例:

Terminal window
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
コマンド目的
champrep mail lsメールボックスフォルダ内のメッセージを一覧表示します。
champrep mail read MESSAGE_ID1 通のメッセージを印刷します。
champrep mail sendメッセージをお送りください。 --subject が必須です。これを含めずに送信する場合は、省略して --no-subject.
champrep mail accounts接続されたメールボックスを一覧表示します。
champrep mail threadsメールスレッドを一覧表示します。
champrep mail domains表示可能なメールドメインを一覧表示します。

使用方法 champrep mail send --help 送信のスクリプト作成前に、インストール済みの バージョンの受信者、件名、本文、および添付ファイルのフラグが正しく処理されるようにしてください。

コマンド目的
champrep chat lsルームの一覧を表示します。
champrep chat read ROOM_ID最近のメッセージを読みます。
champrep chat send ROOM_IDルームメッセージを送信します。
champrep chat unread未読件数を表示します。
champrep chat createルームを作成します。
コマンド目的
champrep contacts ls連絡先を一覧表示します。
champrep contacts search QUERYメールアドレスまたは名前で検索します。
champrep contacts read CONTACT_ID1件の連絡先を表示します。
champrep contacts labelsラベルを一覧表示します。
champrep contacts add USER_IDユーザーを連絡先に追加します。
champrep contacts update CONTACT_ID連絡先のメタデータを更新します。
champrep contacts rm CONTACT_ID連絡先を削除します。

courses また、以下の引数も受け付けます。 learn エイリアス。

コマンド目的
champrep courses ls利用可能なコースを一覧表示します。
champrep courses enrolledアクティブなユーザーの受講登録を一覧表示します。
champrep courses read COURSE_ID1つのコースを表示します。
champrep courses sections COURSE_IDコースのセクションを一覧表示します。
コマンド目的
champrep notes ls最近のメモを一覧表示します。
champrep notes createメモを作成します。
champrep notes read NOTE_IDメモを印刷します。
champrep notes edit NOTE_IDノートのタイトルや本文を更新します。
champrep notes rm NOTE_IDメモを「ゴミ箱」に移動します。30日以内にCHAMPREPNotes から復元してください。それ以降は自動的に削除されます。「ゴミ箱」内のメモは閲覧できますが、編集することはできません。
コマンド目的
eve または champrep ai現在のディレクトリで、Eve 対話型 AI ペアプログラミングエージェントを起動します。
champrep eveのエイリアスです。 champrep ai / eve.
eve -p PROMPT または champrep ai -p PROMPTエージェントをヘッドレスモードで実行し、1つのプロンプトに対して回答を出力します。
champrep ai models lsプラットフォームのモデルおよび独自のキーで登録したモデルを一覧表示します。
champrep ai models register独自のプロバイダーAPIキーを使用するモデルを登録します。
champrep ai models rm NAME登録済みのモデルとそのキーを削除します。
champrep ai pathsエージェントが使用するすべてのローカルファイルおよびフォルダを表示します。
champrep ai chat [PROMPT]単発の質問をしたり、対話型セッションを開始したりします。
champrep ai summarizeファイルを要約します。
champrep ai conversations保存された会話の一覧を表示します。
champrep ai read CONVERSATION_ID会話を閲覧します。
champrep ai rm CONVERSATION_ID会話を削除します。
champrep ai usage現在のAI使用状況を表示します。

AIの出力を信頼する前に、重要な内容を確認してください。

エージェントのスラッシュコマンド、権限、およびオプションについては、 AIエージェント:Eve (champrep ai / eve).

コマンド目的
champrep meet create会議室を作成します。
champrep meet ls会議を一覧表示します。
champrep meet join MEETING_IDデフォルトのブラウザで会議を開きます。

calendar また、以下の引数も受け付けます。 cal エイリアス。

コマンド目的
champrep calendar today本日のイベントを表示します。
champrep calendar week今週の予定を表示します。
champrep calendar createイベントを作成します。
champrep calendar rm EVENT_IDイベントを削除します。

1回のクエリで、認証情報でアクセス可能なすべてのデータを検索します。結果は サービスごとにグループ化され、スキップされた項目は理由とともに一覧表示されます。

コマンド目的
champrep search QUERYすべてのサービスを横断して検索します。
champrep search services検索可能なサービスと、AI検索が利用可能かどうかを表示します。
フラグ目的
-s, --service特定のサービスに限定します(繰り返し実行可能)。クエリの負荷を抑えます。
--limitサービスごとの最大結果数(デフォルトは5件、最大20件)。
--aiAIで結果をランク付けし、簡潔な回答を取得します。ご自身のAIクレジットが消費されます。
Terminal window
champrep search "q3 roadmap"
champrep search "invoice 1042" --service invoice --service mail
champrep search "what did we decide about pricing" --ai

検索には、実際に検索されたサービスごとにレート制限単位が1つ消費されます。そのため、 で絞り込むと --service は、応答性を維持するための最もコスト効率の良い方法です。 --ai これにより、 毎月のAIクレジットが消費されます。クレジットがない場合でも、コマンドは通常の検索結果を返し、 AIランキングが実行されなかった理由が表示されます。

コマンド目的
champrep work boards自分のボードを一覧表示します。
champrep work board BOARD_IDボードを1つ表示します。
champrep work ticketsチケット一覧を表示します。以下の条件でフィルタリングします: --board, --status (ステータスID、または --board ステータス名)、 --search, --mine; --limit 1~200。
champrep work ticket TICKETIDまたはキーで1件のチケットを表示します(例: ENG-7).
champrep work createチケットを作成します(--board, --title, --priority, --type).
Terminal window
champrep work tickets --mine
champrep work create --board 642f... --title "Fix login" --priority high --type bug
コマンド目的
champrep invoice ls請求書の一覧を表示します。以下の条件でフィルタリングします: --status.
champrep invoice read INVOICE_ID1件の請求書を表示します。
champrep invoice issue INVOICE_ID下書きを発行します(下書きから発行済みへ)。
champrep invoice send INVOICE_ID請求書をメールで送信する(--to (受信者が登録されていない場合)。
champrep invoice rm INVOICE_ID下書きを削除します。

請求書の発行および送信には、ご利用のプランの「invoice-send」割り当てが消費されるため、以下の権限が必要です。 invoice:send APIAPIキーのスコープが必要です。

コマンド目的
champrep forms lsフォームの一覧を表示します。
champrep forms read FORM_ID1つのフォームを表示します。
champrep forms responses FORM_IDフォームへの回答を一覧表示します。
champrep forms createフォームを作成する(--title, --description, --publish).
champrep forms publish FORM_ID下書きのフォームを公開します。
champrep forms rm FORM_IDフォームをゴミ箱に移動します。

コマンド目的
champrep charts me組織図上の自分の役職を表示します。
champrep charts tree組織図を JSON 形式で出力します。
champrep charts search QUERY組織内のユーザーを検索します。
champrep charts profile USER_IDユーザーのプロフィールをJSON形式で出力します。

組織(エンタープライズ)の管理。読み取り操作では、 business:read scope。

コマンド目的
champrep business infoご自身の組織およびその組織内での役割を表示します。
champrep business members組織のメンバーを一覧表示します。
champrep business usage組織の利用統計を表示します。

プロジェクト、ブランチ、マージリクエスト、イシュー、パイプライン、ジョブログ、およびリリース。 PROJECT はプロジェクトのフルパスです(acme/web)またはその ID。詳細なリファレンス: CHAMPREP コードコマンド.

コマンド目的
champrep code projects ls / show / createプロジェクトの一覧表示、表示、および作成を行います。
champrep code repo clone-url PROJECTクローンアドレスを出力します(--ssh (SSHの場合は)。
champrep code cloneプロジェクトやグループ(--group, --include-subgroups) またはすべてご自身のもの (--membership, --owned, --all) を名前空間ツリーに追加してください; --update これにより、常に最新の状態が維持されます。
champrep code branches ls PROJECTブランチを一覧表示します。
champrep code mr ls / show / create / merge / approveWork マージリクエストを含む。
champrep code issues ls / show / create / close / reopenWork 課題を含むスキャン。
champrep code pipelines ls / show / run / retry / cancelWork パイプラインとの連携。
champrep code pipelines wait PROJECT [ID]パイプラインを待機し、コミットの最新版を(--sha)、または最新のものを --ref で終了します;exit 0 成功した場合は、 1 それ以外の場合は、 8 on --timeout.
champrep code jobs ls / log / play / retryジョブの一覧表示、出力、または追跡(--follow) ログの表示、手動ジョブの開始。
champrep code releases ls PROJECTリリースの一覧を表示します。
champrep code runners ls / show / update / createランナーの一覧表示やオンライン中のユーザー確認、タグの変更、一時停止と再開、ランナーの作成などを行えます。
champrep code ssh-keys lsSSH経由のgit用に、SSHキーを一覧表示してください。
Terminal window
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

Code、Runner Farm、および QA に関するタスクごとのレシピ(CI の使用方法を含む)は、 一般的なタスク.

runner-farm また、 rf エイリアス。 --workspace ファームの アカウントを選択します(personal, organization:<id>, team:<id>)。詳細なリファレンス: ランナーファームコマンド.

コマンド目的
champrep rf accounts ls / show操作可能なファームアカウントを一覧表示し、1つを表示します。
champrep rf connections lsコードホストの接続を一覧表示します。
champrep rf pools ls / show / create / updateランナープールを管理します。これには以下が含まれます。 --pause および --resume.
champrep rf usage現在の期間のクレジットと分数。
champrep rf jobs ls待機中および保留中のジョブを含め、ジョブを一覧表示します。
Terminal window
champrep rf pools ls
champrep rf usage

リポジトリ、スキャン、検出結果、品質ゲート、プレビュー、および IDE ワークスペース。 REPO は、のようなリポジトリキーです。 code:<project-uuid>。完全なリファレンス: CHAMPREP QA コマンド.

コマンド目的
champrep qa repos ls / available / activate / deactivate / syncリポジトリの QA 分析を管理します。
champrep qa scan REPOスキャンを開始します。 --watch スキャンを最後まで追跡します。
champrep qa scans ls / showスキャンを一覧表示および表示します。
champrep qa findings ls / show / dismiss / reopenフィルタ (--severity, --cwe, --branch, --state) および検出結果のトリアージを行います。
champrep qa gates status REPO品質ゲートの結果を表示します。終了します 1 失敗した際に表示されます。
champrep qa previews ls / show / create / extend / stopプレビュー環境を管理します。
champrep qa ide ls / start / open / stopクラウドIDEワークスペースを管理します。
Terminal window
champrep qa scan code:7d0c5c6e-0b6a-4e2b-9a55-0f8e6c1d2a10 --watch --yes
champrep qa findings ls --severity critical,high

これら3つのカテゴリにおいて、何かを変更したり、CI分、 クレジット、または利用枠を使用するコマンドは、まず次のように確認します: code mr create, mr merge, mr approve, issues close および reopen、すべてのパイプラインおよびジョブアクションにおいて、 rf pools create および update、そしてすべての qa 書き込み (repos activate および deactivate, scan, findings dismiss および reopen, previews create, extend および stop, ide start および stop)。パス --yes (-y) スクリプト内で使用されます。ターミナルがなくても、 また --yes、これらは何も変更しません。Codeプロジェクトやイシューを作成する際も、 確認は行われません。 --workspace on rf および qa 使用されるアカウントと 課金対象となるアカウントを選択します。

コマンド目的
champrep accountご自身のID、プラン、およびリアルタイムのレート制限、1日あたりの使用量、ストレージ使用量を表示します。
Terminal window
champrep account
champrep account --json

の管理 cpk_... ヘッドレスおよびCIアクセスに使用されるキーです。これらのコマンドを 実行するには、対話型のブラウザセッションが必要です(実行 champrep auth login first を使用し、not は使用しません。 auth token)。キーの作成またはローテーションを行うと、シークレットが一度表示されます。

コマンド目的
champrep keys lsご自身のキーAPIを一覧表示します。
champrep keys createキーを作成します(--name、繰り返し実行可能 --scope, --expires-in-days, --allowed-ip).
champrep keys get KEY_ID1つのキーの詳細を表示します。
champrep keys audit KEY_IDキーの最近の監査ログを表示します。
champrep keys update KEY_ID名前、スコープ、IP許可リスト、または --active/--inactive.
champrep keys regenerate KEY_IDシークレットをローテーションします(古いシークレットは使用できなくなります)。
champrep keys revoke KEY_IDキーを削除します。
Terminal window
champrep keys create --name "CI deploy" --scope drive:read --scope drive:write
champrep keys create --name "read-only" --scope '*' --expires-in-days 90

サブスクリプションの読み取り専用ビューを表示します。プランの変更は、請求ダッシュボードで行ってください。

コマンド目的
champrep billing subscription現在のサブスクリプションを表示します(エイリアス sub).
champrep billing cards保存済みの支払い方法を一覧表示します。
champrep billing receipts過去の領収書を一覧表示します。

送信側 Webhook サブスクリプションを管理します。スコープを使用します。 webhooks:manage scope。

コマンド目的
champrep webhooks lsWebhookの一覧を表示してください。
champrep webhooks events購読可能なイベントタイプの一覧を表示します。
champrep webhooks createWebhookの作成 (--url、再現可能 --event)。署名用シークレットは一度だけ表示されます。
champrep webhooks rotate WEBHOOK_ID署名用シークレットをローテーションしてください。
champrep webhooks rm WEBHOOK_IDWebhookを削除します。

これらのコマンドは、ヘルプテキストに 別段の記載がない限り、サービスリクエストを必要としません。

コマンド目的
champrep config get KEY設定値を読み取ります。
champrep config set KEY VALUE許可された設定値を設定してください。 api_url または web_url は必ず https:// アドレスが欠落していること。
champrep config list現在の設定を出力します。以下のコマンドで --json キーはファイル固有のものです(default_environment, api_url …).
champrep config path設定ファイルのパスを表示します。
champrep config env [NAME]デフォルトの環境を表示または設定します。
champrep completion SHELLBash、Zsh、Fish、または PowerShell 用の補完機能を生成します。
champrep versionバージョン、コミット日時、ビルド日時、および実行時の情報を出力します。

トークンは設定ファイルには保存されません。 認証トークンを config set.

コード意味
0成功。
1一般的なエラーや使用上の不具合、あるいは再ログインしても解決しない拒否:アイテムへのアクセス不可、プランに含まれていない、支払いまたはクレジットが必要、役割の問題、またはWebセッションを必要とする決定など。
3認証が必要です、または無効です。
4この認証情報には、必要なスコープが欠けています。
5Gatewayのリアルタイム制限に達しました。
6ネットワーク障害。
7ゲートウェイまたはサービスの障害。
8待機時間が切れてしまいました: code pipelines wait --timeout.

スクリプトでは、終了コードを確認し、 --json 利用可能な場合は 出力を解析します。人間が読み取れるエラー文を、安定したインターフェースとして扱わないでください。

すべてのゲートウェイの応答には、現在の制限情報が含まれています。CLIは、 1分あたりの短い制限に対して透過CLI的に再試行を行い、これを順守します。 Retry-After。これは not sleep 1日あたりの制限や数秒を超える待機時間については待機せず、代わりに コードを返して終了します 5 また、正確な待機時間を報告するため、スクリプトは速やかに失敗します。リアルタイムの カウンターは、いつでも以下のコマンドで確認できます。 champrep account.