開始使用 Checks CLI

Checks CLI 可將 Checks 的功能帶入開發工作流程。您可以在本機、CI/CD 管道中，或透過其他類型的指令碼和自動化項目執行 CLI。

如要設定及使用 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.exe，以便執行檢查指令 (如 checks help 所示)。

更新至最新版 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 控制台的「設定」頁面新增電子郵件地址，並授予「擁有者」角色。如要進一步瞭解如何邀請使用者加入 Checks 帳戶，請參閱「管理團隊存取權」。

使用使用者帳戶進行驗證

重要事項：如果透過 SSH 連線，請轉送通訊埠 9005。

  1. 使用下列指令，透過 Google 帳戶登入 Checks CLI：checks login

    這項指令會將本機電腦連線至 Checks，並授予您 Checks 帳戶的存取權。

    • 如果您先前已登入，但想切換至其他 Google 帳戶，請使用 checks login --reauth。
    • 使用 checks logout 登出。

  2. 在瀏覽器中開啟產生的驗證網址。

  3. 登入 Google 帳戶。

  4. 同意授權 Checks 存取您的 Checks 帳戶。