コンテンツにスキップ

CLI コマンドリファレンス

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

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

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

コマンド 目的
champrep auth login ブラウザの承認を通じてサインインします。
champrep auth login --no-browser リモート端末用の承認URLを印刷します。
champrep auth token スコープ付きキーAPIをOSのキーチェーンに保存します。
champrep auth whoami アクティブな ID およびプロファイルを表示します。
champrep auth status ID、リアルタイムのクォータ、および利用可能な監査コンテキストを表示します。
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_ID 1 通のメッセージを印刷します。
champrep mail send フラグやプロンプトを使用してメッセージを送信します。
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_ID 1件の連絡先を表示します。
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_ID 1つのコースを表示します。
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 メモを削除します。
コマンド 目的
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の出力を信頼する前に、重要な内容を確認してください。

コマンド 目的
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件)。
--ai AIで結果をランク付けし、簡潔な回答を取得します。ご自身の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, --search, --mine.
champrep work ticket TICKET IDまたはキーで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_ID 1件の請求書を表示します。
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_ID 1つのフォームを表示します。
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 組織の利用統計を表示します。

コマンド 目的
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_ID 1つのキーの詳細を表示します。
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 ls Webhookの一覧を表示してください。
champrep webhooks events 購読可能なイベントタイプの一覧を表示します。
champrep webhooks create Webhookの作成 (--url、再現可能 --event)。署名用シークレットは一度だけ表示されます。
champrep webhooks rotate WEBHOOK_ID 署名用シークレットをローテーションしてください。
champrep webhooks rm WEBHOOK_ID Webhookを削除します。

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

コマンド 目的
champrep config get KEY 設定値を読み取ります。
champrep config set KEY VALUE 許可される設定値を設定します。
champrep config list 現在の設定を表示します。
champrep config path 設定ファイルのパスを表示します。
champrep config env [NAME] デフォルトの環境を表示または設定します。
champrep completion SHELL Bash、Zsh、Fish、または PowerShell 用の補完機能を生成します。
champrep version バージョン、コミット日時、ビルド日時、および実行時の情報を出力します。

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

コード 意味
0 成功。
1 一般的なエラー、または使用上のエラーです。
3 認証が必要です、または無効です。
4 この認証情報には、必要なスコープが欠けています。
5 Gatewayのリアルタイム制限に達しました。
6 ネットワーク障害。
7 ゲートウェイまたはサービスの障害。

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

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