Erste Schritte mit der Checks CLI

Die Checks CLI bringt die Funktionalität von Checks in Ihren Entwicklungsablauf. Sie können die CLI lokal, in Ihrer CI/CD-Pipeline oder über andere Arten von Skripts und Automatisierung ausführen.

Für die Einrichtung und Verwendung der Checks CLI sind folgende Schritte erforderlich:

  1. Checks CLI installieren
  2. Computer authentifizieren
  3. Checks CLI integrieren und verwenden, indem Sie Befehle über die Befehls zeile ausführen oder die Checks CLI in Ihre CI/CD-Umgebung einbinden.

Checks CLI einrichten

Sie können die Checks CLI mit den eigenständigen ausführbaren Dateien in den Tabellen für Linux oder macOS installieren oder aktualisieren.

Nach der Installation der Checks CLI müssen Sie sich authentifizieren. Anschließend können Sie mit dem Testen und Beheben von Sicherheitslücken beginnen. Testen Sie zuerst Ihre Installation.

Mit eigenständigen ausführbaren Dateien installieren

Checks bietet Downloadlinks für eigenständige ausführbare Dateien für die neueste Version und für bestimmte Versionen. Die folgenden Links sind beispielsweise für macOS und Linux:

So laden Sie beispielsweise die neueste Checks CLI unter macOS herunter und führen sie aus:

curl --compressed https://dl.google.com/checks/cli/latest/checks-macos -o checks
chmod +x ./checks
mv ./checks /usr/local/bin/
  1. Prüfen Sie, ob Sie Ihren Paketmanager und alle erforderlichen Drittanbietertools installiert haben.
  2. Laden Sie die Checks CLI-Binärdatei für Ihre Plattform herunter:

Linux

Plattform

Paket

Größe

SHA256-Prüfsumme

Linux

checks-linux

35,1 MB

cc12317c0d5b0a2edfe8d5bf28a3a0739d5bd469ccd771772bf65129ae97c94f

Machen Sie die Binärdatei mit dem Befehl chmod +x ./checks ausführbar. (Optional) Verschieben Sie die Binärdatei an einen Ort, an dem Sie sie global ausführen können: mv ./checks /usr/local/bin/

macOS

Plattform

Paket

Größe

SHA256-Prüfsumme

macOS

checks-macos

29,4 MB

a82699336aaf0f6b0a9502c293c84be45459d79d348a74eae3bbaaf89d1daa33

Machen Sie die Binärdatei mit dem Befehl chmod +x ./checks ausführbar. (Optional) Verschieben Sie die Binärdatei an einen Ort, an dem Sie sie global ausführen können: mv ./checks /usr/local/bin/

Windows

Plattform

Paket

Größe

SHA256-Prüfsumme

Windows 8.1 und höher sowie Windows Server 2012 und höher

checks-win.exe

29,5 MB

7ca465e28ffec9a7e16bc71e01bbaf9629c95d517e5846a31280a49af400d3c7

(Optional) Benennen Sie die Datei in checks.exe um, damit Sie Checks-Befehle wie dokumentiert ausführen können, z. B. checks help.

Auf die neueste CLI-Version aktualisieren

Damit Sie die neuesten Funktionen und Fehlerkorrekturen erhalten, empfehlen wir Ihnen, regelmäßig nach Updates für die CLI zu suchen.

Sie können die neue Version aus den vorherigen Tabellen herunterladen und dann die vorherige Version auf Ihrem System ersetzen.

Installation testen

Nach der Authentifizierung können Sie Ihre Installation testen. Führen Sie für einen schnellen Test checks --help aus.

Weitere Informationen

Führen Sie checks --help aus oder lesen Sie die Zusammenfassung der CLI-Befehle und -Optionen.

Support

Senden Sie eine E-Mail an checks-support@google.com, wenn Sie Hilfe mit der Checks CLI oder Checks im Allgemeinen benötigen.

CLI authentifizieren

Nach der Installation der CLI müssen Sie sich in einem Google-Konto anmelden. Um den Zugriff der Checks CLI auf Checks zu autorisieren, verwenden Sie entweder ein Dienstkonto oder ein Nutzerkonto.

Ein Dienstkonto ist ein mit Ihrem Google Cloud-Projekt (und nicht mit einem bestimmten Nutzer) verknüpftes Google Cloud-Konto. Dienstkonten sind nützlich, um Checks in einer CI-Umgebung einzurichten.

Ein Nutzerkonto ist ein Google-Konto, das Zugriff auf Ihr Checks-Konto hat. Dies ist die beste Option, um die Checks CLI über die Befehlszeile zu verwenden.

Mit Dienstkonto authentifizieren

  1. Öffnen Sie die Google Cloud Console und wählen Sie Ihr Projekt aus.
  2. Aktivieren Sie in der API-Bibliothek die Checks API.
  3. Erstellen Sie ein Dienstkonto für Ihr Projekt, indem Sie in der Google Cloud Console zur Seite „IAM-Dienst konten“ navigieren. Klicken Sie auf Dienstkonto erstellen und geben Sie die Details zum Dienstkonto ein.
    1. Erstellen Sie einen privaten JSON-Schlüssel für das neu erstellte Dienstkonto und verschieben Sie den Schlüssel an einen Ort, auf den Ihre Build-Umgebung zugreifen kann. Bewahren Sie diese Datei an einem sicheren Ort auf, da sie Administratorzugriff auf Checks gewährt.
    2. Legen Sie die Umgebungsvariable CHECKS_CREDENTIALS auf den Pfad Ihrer privaten JSON-Schlüsseldatei fest, wenn Sie die CLI verwenden. Wenn Sie ein Checks CI/CD-Plug-in verwenden, finden Sie in der Dokumentation des Plug-ins Informationen zum Bereitstellen der Anmeldedaten.
  4. Wenn Sie dem Dienstkonto Zugriff auf Ihr Checks-Konto gewähren möchten, fügen Sie die E-Mail-Adresse hinzu und weisen Sie ihr auf der Seite „Einstellungen der Checks Console“ die Rolle Owner zu. Weitere Informationen zum Einladen von Nutzern in Ihr Checks-Konto finden Sie unter Teamzugriff verwalten.

Mit Nutzerkonto authentifizieren

Wichtig:Wenn Sie eine Verbindung über SSH herstellen, leiten Sie Port 9005 weiter.

  1. Melden Sie sich mit dem folgenden Befehl mit Ihrem Google-Konto in der Checks CLI an: checks login

    Mit diesem Befehl wird Ihr lokaler Computer mit Checks verbunden und Sie erhalten Zugriff auf Ihre Checks-Konten.

    • Verwenden Sie checks login --reauth, wenn Sie sich bereits angemeldet haben, aber zu einem anderen Google-Konto wechseln möchten.
    • Verwenden Sie checks logout, um sich abzumelden.

  2. Öffnen Sie die generierte Authentifizierungs-URL im Browser.

  3. Melden Sie sich in Ihrem Google-Konto an.

  4. Erteilen Sie Checks die Berechtigung, auf Ihr Checks-Konto zuzugreifen.