このページでは、CLI コマンドと各コマンドのオプションの概要を示します。Checks CLI コマンドの詳細については、--help オプション（checks login --help や checks reports --help など）を使用します。
使用状況
checks GROUP | COMMAND ARGUMENT \
[OPTIONAL=FLAG_ARGUMENT] \
{OPTIONAL_A | OPTIONAL_B}
[CHECKS_WIDE_FLAG …]
使用可能な CLI コマンド
設定
コマンド |
Description |
login |
Google アカウントで CLI を認証します。ウェブブラウザ アクセスが必要です。 |
update |
利用可能な最新バージョンの Checks CLI を取得します。 |
help |
CLI または特定のコマンドに関するヘルプ情報を表示します。 |
version |
Checks CLI コンポーネントのバージョン情報を出力し、アップデートが利用可能な場合はメッセージを含めます。 |
レポート
コマンド |
Description |
レポート生成 |
提供されたバイナリを使用して、指定したアカウントとアプリでレポートを非同期で生成します。 |
レポートの取得 |
指定したアプリのレポートからデータを取得します。 |
レポート オペレーションの待機 |
完了するまで、長時間実行レポート オペレーションをポーリングします。オペレーションが完了すると、このコマンドによってレポートの結果が表示されます。 |
レポート オペレーション リスト |
指定したアカウントのすべてのレポート オペレーションを一覧表示します。 |
共通フラグ
フラグ |
Description |
アカウント ID |
特定の Checks アカウントを参照するために使用します。 |
help |
サポートされているフラグや引数など、特定のコマンドのヘルプ ドキュメントを提供します。 |
version |
CLI のバージョン情報を出力して終了します。このフラグはグローバルでのみ使用できます。 |
未入力 |
これにより、ユーザーは明示的にコマンドですべてのプロンプトを無効にできます。コマンドに入力が必要な場合は失敗し、フラグとして情報を渡す方法をユーザーに伝えます。 |
json |
デフォルトでは、レスポンスは標準出力にきれいに出力されます。 |
wait-and-print-report |
レポートの生成が終了するまでコマンドの戻り値をブロックする |