Pierwsze kroki z interfejsem wiersza poleceń Checks

Interfejs wiersza poleceń Checks wprowadza funkcje Checks do Twojego procesu programowania. Interfejs wiersza poleceń możesz uruchamiać lokalnie, w potoku CI/CD lub za pomocą innych rodzajów skryptów i automatyzacji.

Konfigurowanie i używanie interfejsu wiersza poleceń Checks wymaga wykonania tych czynności:

  1. Instalowanie interfejsu wiersza poleceń Checks
  2. Uwierzytelnianie urządzenia
  3. Zintegruj i używaj interfejsu wiersza poleceń Checks, uruchamiając polecenia z wiersza poleceń lub integrując go ze swoim środowiskiem CI/CD.

Konfigurowanie interfejsu wiersza poleceń Checks

Interfejs wiersza poleceń Checks możesz zainstalować lub zaktualizować, korzystając z samodzielnych plików wykonywalnych w tabelach dla systemów Linux lub macOS.

Po zainstalowaniu interfejsu Checks CLI musisz się uwierzytelnić. Następnie możesz rozpocząć testowanie i usuwanie luk w zabezpieczeniach, zaczynając od testowania instalacji.

.

Instalowanie za pomocą samodzielnych plików wykonywalnych

Checks udostępnia samodzielne linki do pobierania plików wykonywalnych najnowszej wersji i określonych wersji. Na przykład te linki są przeznaczone dla systemów macOS i Linux:

Aby na przykład pobrać i uruchomić najnowszą wersję interfejsu wiersza poleceń Checks w systemie macOS, uruchom to polecenie:

curl --compressed https://dl.google.com/checks/cli/latest/checks-macos -o checks
chmod +x ./checks
mv ./checks /usr/local/bin/
  1. Sprawdź, czy masz zainstalowany menedżer pakietów i wszystkie wymagane narzędzia innych firm.
  2. Pobierz plik binarny interfejsu wiersza poleceń Checks dla swojej platformy:

Linux

Platforma

Pakiet

Rozmiar

Suma kontrolna SHA256

Linux

checks-linux

35,1 MB

cc12317c0d5b0a2edfe8d5bf28a3a0739d5bd469ccd771772bf65129ae97c94f

Ustaw plik binarny jako wykonywalny, uruchamiając polecenie chmod +x ./checks. (Opcjonalnie) Przenieś plik binarny do lokalizacji, w której można go uruchamiać globalnie: mv ./checks /usr/local/bin/

macOS

Platforma

Pakiet

Rozmiar

Suma kontrolna SHA256

macOS

checks-macos

29,4 MB

a82699336aaf0f6b0a9502c293c84be45459d79d348a74eae3bbaaf89d1daa33

Ustaw plik binarny jako wykonywalny, uruchamiając chmod +x ./checks (opcjonalnie) Przenieś plik binarny do lokalizacji, w której można go uruchomić globalnie: mv ./checks /usr/local/bin/

Windows

Platforma

Pakiet

Rozmiar

Suma kontrolna SHA256

Windows 8.1 i nowsze oraz Windows Server 2012 i nowsze

checks-win.exe

29,5 MB

7ca465e28ffec9a7e16bc71e01bbaf9629c95d517e5846a31280a49af400d3c7

(Opcjonalnie) Zmień nazwę pliku na checks.exe, aby móc uruchamiać polecenia sprawdzania zgodnie z dokumentacją, np. checks help.

Aktualizowanie do najnowszej wersji interfejsu CLI

Aby mieć pewność, że korzystasz z najnowszych funkcji i poprawek błędów, zalecamy częste sprawdzanie dostępności aktualizacji interfejsu CLI.

Nową wersję możesz pobrać z tabel powyżej, a następnie zastąpić nią poprzednią wersję w swoim systemie.

Testowanie instalacji

Po uwierzytelnieniu możesz przetestować instalację. Aby przeprowadzić szybki test, uruchom polecenie checks --help.

Dodatkowe informacje

Uruchom checks --help lub zapoznaj się z podsumowaniem poleceń i opcji interfejsu wiersza poleceń.

Korzystanie z pomocy

Jeśli potrzebujesz pomocy dotyczącej interfejsu wiersza poleceń Checks lub usługi Checks, wyślij e-maila na adres checks-support@google.com.

Uwierzytelnianie interfejsu wiersza poleceń

Po zainstalowaniu interfejsu CLI musisz zalogować się na konto Google. Aby autoryzować dostęp interfejsu wiersza poleceń Checks do usługi Checks, użyj konta usługi lub konta użytkownika.

Konto usługi to konto Google Cloud powiązane z projektem Google Cloud, a nie z konkretnym użytkownikiem. Konta usługi są przydatne do konfigurowania testów w środowisku CI.

Konto użytkownika to konto Google, które ma dostęp do Twojego konta Checks. To najlepsza opcja korzystania z interfejsu wiersza poleceń Checks z wiersza poleceń.

Uwierzytelnianie za pomocą konta usługi

  1. Otwórz konsolę Google Cloud i wybierz swój projekt.
  2. W Bibliotece API włącz Checks API.
  3. Utwórz konto usługi dla swojego projektu, otwierając stronę Konta usługi IAM w konsoli Google Cloud. Kliknij Utwórz konto usługi i wpisz szczegóły konta usługi.
    1. Utwórz prywatny klucz JSON dla nowo utworzonego konta usługi i przenieś go do lokalizacji dostępnej dla środowiska kompilacji. Przechowuj ten plik w bezpiecznym miejscu, ponieważ daje on dostęp do weryfikacji z uprawnieniami administratora.
    2. Podczas korzystania z interfejsu wiersza poleceń ustaw zmienną środowiskową CHECKS_CREDENTIALS na ścieżkę pliku JSON klucza prywatnego. Jeśli używasz wtyczki Checks CI/CD, zapoznaj się z jej dokumentacją, aby dowiedzieć się, jak podać dane logowania.
  4. Aby przyznać kontu usługi dostęp do konta Checks, dodaj adres e-mail i przypisz mu rolę Właściciel na stronie Ustawienia konsoli Checks. Więcej informacji o zapraszaniu użytkowników do korzystania z konta Checks znajdziesz w artykule Zarządzanie dostępem zespołu.

Uwierzytelnianie za pomocą konta użytkownika

Ważne: jeśli łączysz się przez SSH, przekieruj port 9005.

  1. Zaloguj się w interfejsie Checks CLI za pomocą konta Google, używając tego polecenia: checks login

    To polecenie łączy komputer lokalny z usługą Checks i przyznaje dostęp do kont Checks.

    • Użyj opcji checks login --reauth, jeśli masz już konto, ale chcesz przełączyć się na inne konto Google.
    • Aby się wylogować, użyj checks logout.

  2. Otwórz wygenerowany adres URL uwierzytelniania w przeglądarce.

  3. Zaloguj się na konto Google.

  4. Wyraź zgodę na dostęp usługi Checks do Twojego konta Checks.