CLI コマンドとオプションを確認する

このページでは、CLI コマンドと各コマンドのオプションの概要について説明します。各 Checks CLI コマンドの詳細については、--help オプション(checks login --helpchecks reports --help など)を使用します。

用途

checks GROUP | COMMAND ARGUMENT \
    [OPTIONAL=FLAG_ARGUMENT] \
    {OPTIONAL_A | OPTIONAL_B}
    [CHECKS_WIDE_FLAG ]

使用可能な CLI コマンド

構成

コマンド

説明

login

Google アカウントを使用して CLI の認証を行います。ウェブブラウザへのアクセスが必要です。

update

利用可能な Checks CLI の最新バージョンを取得します。

help

CLI または特定のコマンドに関するヘルプ情報を表示します。

version

Checks CLI コンポーネントのバージョン情報を出力し、更新が利用可能な場合はメッセージを表示します。

レポート

コマンド

説明

レポートの生成

指定されたアカウントとアプリで、指定されたバイナリを使用してレポートを非同期で生成します。

レポートを取得

指定されたアプリのレポートからデータを取得します。

report operations wait

長時間実行レポート オペレーションが完了するまでポーリングします。オペレーションが完了すると、このコマンドはレポートの結果を表示します。

レポート オペレーションのリスト

指定されたアカウントのすべてのレポート オペレーションを一覧表示します。

コード

コマンド

説明

コード スキャン

指定されたパスで Checks Code Compliance を使用してソースコードをスキャンします。

一般的なフラグ

フラグ

説明

account-id

特定の Checks アカウントを参照するために使用されます。

help

サポートされているフラグと引数など、指定されたコマンドのヘルプ ドキュメントを提供します。

version

CLI のバージョン情報を出力して終了します。このフラグはグローバルでのみ使用できます。

no-input

これにより、ユーザーはコマンドですべてのプロンプトを明示的に無効にできます。コマンドに入力が必要な場合は、失敗して、情報をフラグとして渡す方法をユーザーに伝えます。

json

デフォルトでは、レスポンスは標準出力に整った形で出力されます。json フラグを使用すると、デフォルトの出力を JSON 形式にフォーマットして変更できます。

wait-and-print-report

レポートの生成が完了するまでコマンドの戻りをブロックする report generate コマンドの便利なフラグ。