Premiers pas avec la CLI Checks

La CLI Checks apporte les fonctionnalités de Checks à votre workflow de développement. Vous pouvez exécuter la CLI localement, dans votre pipeline CI/CD ou via d'autres types de scripts et d'automatisation.

Pour configurer et utiliser la CLI Checks, procédez comme suit :

  1. Installez la CLI Checks.
  2. Authentifiez votre machine.
  3. Intégrez et utilisez la CLI Checks en exécutant des commandes à partir de la ligne de commande ou en intégrant la CLI Checks dans votre environnement CI/CD.

Configurer la CLI Checks

Vous pouvez installer ou mettre à jour la CLI Checks à l'aide des exécutables autonomes dans les tableaux pour Linux ou macOS.

Après avoir installé la CLI Checks, vous devez vous authentifier. Vous pouvez ensuite commencer à tester et à corriger vos failles, en commençant par tester votre installation.

Installer avec des exécutables autonomes

Checks fournit des liens de téléchargement d'exécutables autonomes pour la dernière version et pour des versions spécifiques. Les liens suivants, par exemple, concernent macOS et Linux :

Par exemple, pour télécharger et exécuter la dernière CLI Checks sur macOS, exécutez la commande suivante :

curl --compressed https://dl.google.com/checks/cli/latest/checks-macos -o checks
chmod +x ./checks
mv ./checks /usr/local/bin/
  1. Assurez-vous d'avoir installé votre gestionnaire de packages et tous les outils tiers requis.
  2. Téléchargez le binaire de la CLI Checks pour votre plate-forme :

Linux

Plate-forme

Package

Taille

Somme de contrôle SHA256

Linux

checks-linux

35,1 Mo

cc12317c0d5b0a2edfe8d5bf28a3a0739d5bd469ccd771772bf65129ae97c94f

Rendez le binaire exécutable en exécutant chmod +x ./checks. (Facultatif) Déplacez le binaire vers un emplacement où vous pouvez l'exécuter globalement : mv ./checks /usr/local/bin/

macOS

Plate-forme

Package

Taille

Somme de contrôle SHA256

macOS

checks-macos

29,4 Mo

a82699336aaf0f6b0a9502c293c84be45459d79d348a74eae3bbaaf89d1daa33

Rendez le binaire exécutable en exécutant chmod +x ./checks (Facultatif) Déplacez le binaire vers un emplacement où vous pouvez l'exécuter globalement : mv ./checks /usr/local/bin/

Windows

Plate-forme

Package

Taille

Somme de contrôle SHA256

Windows 8.1 et versions ultérieures, Windows Server 2012 et versions ultérieures

checks-win.exe

29,5 Mo

7ca465e28ffec9a7e16bc71e01bbaf9629c95d517e5846a31280a49af400d3c7

(Facultatif) Renommez le fichier en checks.exe afin de pouvoir exécuter les commandes de vérification comme indiqué dans la documentation, par exemple checks help.

Mettre à jour vers la dernière version de la CLI

Pour vous assurer de bénéficier des dernières fonctionnalités et corrections de bugs, nous vous recommandons de vérifier régulièrement les mises à jour de la CLI.

Vous pouvez télécharger la nouvelle version à partir des tableaux précédents, puis remplacer la version précédente sur votre système.

Tester votre installation

Après l'authentification, vous pouvez tester votre installation. Pour un test rapide, exécutez checks --help.

Informations supplémentaires

Exécutez checks --help ou consultez le résumé des commandes et options de la CLI.

Assistance

Envoyez un e-mail à checks-support@google.com chaque fois que vous avez besoin d'aide concernant la CLI Checks ou Checks en général.

Authentifier la CLI

Après avoir installé la CLI, vous devez vous connecter à un compte Google. Pour autoriser l'accès de la CLI Checks à Checks, utilisez un compte de service ou un compte utilisateur.

Un compte de service est un compte Google Cloud associé à votre projet Google Cloud, et non à un utilisateur spécifique. Les comptes de service sont utiles pour configurer Checks dans un environnement CI.

Un compte utilisateur est un compte Google qui a accès à votre compte Checks. Il s'agit de la meilleure option pour utiliser la CLI Checks à partir de votre ligne de commande.

S'authentifier avec un compte de service

  1. Ouvrez la console Google Cloud et sélectionnez votre projet.
  2. Dans la bibliothèque d'API, activez l'API Checks.
  3. Créez un compte de service pour votre projet en accédant à la page "Comptes de service IAM" dans la console Google Cloud. Cliquez sur Créer un compte de service , puis saisissez les détails du compte de service.
    1. Créez une clé JSON privée pour le compte de service que vous venez de créer, puis déplacez-la vers un emplacement accessible à votre environnement de compilation. Veillez à conserver ce fichier dans un endroit sûr, car il accorde un accès administrateur à Checks.
    2. Définissez la variable d'environnement CHECKS_CREDENTIALS sur le chemin d'accès à votre fichier JSON de clé privée lorsque vous utilisez la CLI. Si vous utilisez un plug-in CI/CD Checks, consultez la documentation du plug-in pour savoir comment fournir les identifiants.
  4. Pour accorder l'accès du compte de service à votre compte Checks, ajoutez l'adresse e-mail et attribuez-lui le rôle Propriétaire sur la page "Paramètres de la console Checks". Pour en savoir plus sur l'invitation d'utilisateurs à votre compte Checks, consultez la page Gérer l'accès de l'équipe.

S'authentifier avec un compte utilisateur

Important : Si vous vous connectez via SSH, transférez le port 9005.

  1. Connectez-vous à la CLI Checks à l'aide de votre compte Google avec la commande suivante : checks login

    Cette commande connecte votre machine locale à Checks et vous donne accès à vos comptes Checks.

    • Utilisez checks login --reauth si vous vous êtes déjà connecté, mais que vous souhaitez passer à un autre compte Google.
    • Utilisez checks logout pour vous déconnecter.

  2. Ouvrez l'URL d'authentification générée dans le navigateur.

  3. Connectez-vous à votre compte Google.

  4. Autorisez Checks à accéder à votre compte Checks.