Checks CLI を使ってみる

Checks CLI は、Checks の機能を開発ワークフローに組み込みます。CLI は、ローカル、CI/CD パイプライン、または他のタイプのスクリプトや自動化で実行できます。

Checks CLI を設定して使用するには、次の手順が必要です。

  1. Checks CLI をインストールする
  2. マシンを認証する
  3. コマンドラインからコマンドを実行するか、Checks CLI を CI/CD 環境に統合して、Checks CLI を統合して使用します。

Checks CLI を設定する

Checks CLI をインストールまたは更新するには、Linux または macOS のいずれかの表にあるスタンドアロン実行可能ファイルを使用します。

Checks CLI をインストールしたら、認証する必要があります。その後、インストール テストから始めて、脆弱性のテストと修正を開始できます。

スタンドアロン実行可能ファイルを使用してインストールする

Checks では、最新リリースと特定のバージョン用のスタンドアロン実行可能ファイルのダウンロード リンクが提供されます。たとえば、次のリンクは macOS と Linux 用です。

たとえば、macOS で最新の Checks CLI をダウンロードして実行するには、次のコマンドを実行します。

curl --compressed https://dl.google.com/checks/cli/latest/checks-macos -o checks
chmod +x ./checks
mv ./checks /usr/local/bin/
  1. パッケージ マネージャーと必要なサードパーティ製ツールがインストールされていることを確認します。
  2. プラットフォーム用の Checks CLI バイナリをダウンロードします。

Linux

プラットフォーム

パッケージ

サイズ

SHA256 チェックサム

Linux

checks-linux

35.1 MB

cc12317c0d5b0a2edfe8d5bf28a3a0739d5bd469ccd771772bf65129ae97c94f

chmod +x ./checks を実行して、バイナリを実行可能にします。（省略可）バイナリをグローバルに実行できる場所に移動します。mv ./checks /usr/local/bin/

macOS

プラットフォーム

パッケージ

サイズ

SHA256 チェックサム

macOS

checks-macos

29.4 MB

a82699336aaf0f6b0a9502c293c84be45459d79d348a74eae3bbaaf89d1daa33

chmod +x ./checks を実行して、バイナリを実行可能にします（省略可）。バイナリをグローバルに実行できる場所に移動します。mv ./checks /usr/local/bin/

Windows

プラットフォーム

パッケージ

サイズ

SHA256 チェックサム

Windows 8.1 以降、Windows Server 2012 以降

checks-win.exe

29.5 MB

7ca465e28ffec9a7e16bc71e01bbaf9629c95d517e5846a31280a49af400d3c7

（省略可）ドキュメントに記載されているチェックコマンド（checks help など）を実行できるように、ファイルの名前を checks.exe に変更します。

最新の CLI バージョンに更新する

最新の機能やバグ修正を確実に利用できるようにするため、CLI の更新を頻繁に確認することをおすすめします。

上記の表から新しいバージョンをダウンロードし、システム上の以前のバージョンを置き換えることができます。

インストールをテストする

認証後、インストールをテストできます。簡単なテストを行うには、checks --help を実行します。

その他の情報

checks --help を実行するか、CLI コマンドとオプションの概要をご覧ください。

サポートの利用

Checks CLI または Checks 全般についてサポートが必要な場合は、checks-support@google.com にメールを送信してください。

CLI を認証する

CLI をインストールしたら、Google アカウントにログインする必要があります。Checks CLI が Checks にアクセスできるようにするには、サービス アカウントまたはユーザー アカウントを使用します。

サービス アカウントは、Google Cloud プロジェクトに関連付けられている Google Cloud アカウントであり、特定のユーザーではありません。サービス アカウントは、CI 環境でチェックを設定するのに役立ちます。

ユーザー アカウントは、Checks アカウントにアクセスできる Google アカウントです。これは、コマンドラインから Checks CLI を使用する場合に最適なオプションです。

サービス アカウントで認証する

  1. Google Cloud コンソールを開き、プロジェクトを選択します。
  2. API ライブラリで、Checks API を有効にします。
  3. Google Cloud コンソールの IAM サービス アカウント ページに移動して、プロジェクトのサービス アカウントを作成します。[サービス アカウントを作成] をクリックし、サービス アカウントの詳細を入力します。
    1. 新しく作成したサービス アカウントの JSON 秘密鍵を作成し、ビルド環境からアクセスできる場所に移動します。このファイルは安全な場所に保管してください。管理者が Checks にアクセスするために、このファイルが必要になります。
    2. CLI を使用する場合は、環境変数 CHECKS_CREDENTIALS を秘密鍵 JSON ファイルのパスに設定します。Checks CI/CD プラグインを使用している場合は、認証情報の提供方法についてプラグインのドキュメントを参照してください。
  4. サービス アカウントに Checks アカウントへのアクセス権を付与するには、Checks Console の [設定] ページでメールアドレスを追加し、オーナーロールを付与します。Checks アカウントへのユーザーの招待について詳しくは、チーム アクセスの管理をご覧ください。

ユーザー アカウントで認証する

重要: SSH 経由で接続する場合は、ポート 9005 を転送します。

  1. 次のコマンドを使用して、Google アカウントで Checks CLI にログインします。checks login

    このコマンドにより、ローカルマシンが Checks に接続し、Checks アカウントへのアクセスが許可されます。

    • 以前にログインしたことがあるが、別の Google アカウントに切り替えたい場合は、checks login --reauth を使用します。
    • ログアウトするには checks logout を使用します。

  2. 生成された認証 URL をブラウザで開きます。

  3. Google アカウントにログインします。

  4. Checks アカウントへのアクセスを Checks に許可します。