Começar a usar a CLI Checks

A CLI do Checks traz a funcionalidade do Checks para seu fluxo de trabalho de desenvolvimento. É possível executar a CLI localmente, no pipeline de CI/CD ou em outros tipos de scripts e automação.

Para configurar e usar a CLI do Checks, siga estas etapas:

  1. Instale a CLI do Checks
  2. Autentique sua máquina
  3. Integre e use a CLI do Checks executando comandos na linha de comando ou integrando a CLI do Checks ao seu ambiente de CI/CD.

Configurar a CLI do Checks

É possível instalar ou atualizar a CLI do Checks usando os executáveis independentes nas tabelas para Linux ou macOS.

Depois de instalar a CLI do Checks, será preciso fazer a autenticação. Em seguida, você pode começar a testar e corrigir suas vulnerabilidades, começando pelo teste de instalação.

Instalar com executáveis independentes

O Checks oferece links de download executáveis independentes para a versão mais recente e para versões específicas. Os links a seguir, por exemplo, são para macOS e Linux:

Por exemplo, para fazer o download e executar a CLI do Checks mais recente no macOS, execute:

curl --compressed https://dl.google.com/checks/cli/latest/checks-macos -o checks
chmod +x ./checks
mv ./checks /usr/local/bin/
  1. Verifique se você instalou o gerenciador de pacotes e todas as ferramentas de terceiros necessárias.
  2. Faça o download do binário da CLI do Checks para sua plataforma:

Linux

Plataforma

Pacote

Tamanho

Soma de verificação SHA256

Linux

checks-linux

35,1 MB

cc12317c0d5b0a2edfe8d5bf28a3a0739d5bd469ccd771772bf65129ae97c94f

Execute chmod +x ./checks para tornar o binário executável. (Opcional) Mova o binário para um local em que ele possa ser executado globalmente: mv ./checks /usr/local/bin/

macOS

Plataforma

Pacote

Tamanho

Soma de verificação SHA256

macOS

checks-macos

29,4 MB

a82699336aaf0f6b0a9502c293c84be45459d79d348a74eae3bbaaf89d1daa33

Execute chmod +x ./checks para tornar o binário executável. (Opcional) Mova o binário para um local em que ele possa ser executado globalmente: mv ./checks /usr/local/bin/

Windows

Plataforma

Pacote

Tamanho

Soma de verificação SHA256

Windows 8.1 e versões mais recentes e Windows Server 2012 e versões mais recentes

checks-win.exe

29,5 MB

7ca465e28ffec9a7e16bc71e01bbaf9629c95d517e5846a31280a49af400d3c7

(Opcional) Renomeie o arquivo para checks.exe para que você possa executar comandos de verificação conforme documentado, por exemplo, checks help.

Atualizar para a versão mais recente da CLI

Para garantir que você tenha os recursos e as correções de bugs mais recentes, recomendamos que você verifique com frequência se há atualizações da CLI.

É possível fazer o download da nova versão nas tabelas anteriores e substituir a versão anterior no sistema.

Testar a instalação

Depois de fazer a autenticação, você pode testar a instalação. Para um teste rápido, execute checks --help.

Informações adicionais

Execute checks --help ou consulte o resumo dos comandos e opções da CLI.

Como receber suporte

Envie um e-mail para checks-support@google.com sempre que precisar de ajuda com a CLI do Checks ou o Checks em geral.

Autenticar a CLI

Depois de instalar a CLI, é necessário fazer login em uma Conta do Google. Para autorizar o acesso da CLI do Checks ao Checks, use uma conta de serviço ou de usuário.

Uma conta de serviço é uma Conta do Google associada ao seu projeto do Google Cloud e não a um usuário específico. As contas de serviço são úteis para configurar o Checks em um ambiente de CI.

Uma conta de usuário é uma Conta do Google que tem acesso à sua conta do Checks. Essa é a melhor opção para usar a CLI do Checks na linha de comando.

Autenticar com uma conta de serviço

  1. Abra o console do Google Cloud e selecione seu projeto.
  2. Na Biblioteca de APIs, ative a API Checks.
  3. Crie uma conta de serviço para seu projeto acessando a página Contas de serviço do IAM no console do Google Cloud. Clique em Criar conta de serviço e insira os detalhes da conta de serviço.
    1. Crie uma chave JSON privada para a conta de serviço recém-criada e mova a chave para um local acessível ao seu ambiente de build. Mantenha esse arquivo em um local seguro, porque ele concede acesso de administrador ao Checks.
    2. Defina a variável de ambiente CHECKS_CREDENTIALS como o caminho do arquivo JSON da chave privada ao usar a CLI. Se você estiver usando um plug-in de CI/CD do Checks, consulte a documentação do plug-in para saber como fornecer as credenciais.
  4. Para conceder acesso à conta de serviço à sua conta do Checks, adicione o endereço de e-mail e atribua a ele o papel de Proprietário na página "Configurações do console do Checks". Para mais informações sobre como convidar usuários para sua conta do Checks, consulte Gerenciar o acesso da equipe.

Autenticar com uma conta de usuário

Importante:se você estiver se conectando por SSH, encaminhe a porta 9005.

  1. Faça login na CLI do Checks usando sua Conta do Google com o seguinte comando: checks login

    Esse comando conecta sua máquina local ao Checks e concede acesso às suas contas do Checks.

    • Use checks login --reauth se você já tiver feito login, mas quiser mudar para outra Conta do Google.
    • Use checks logout para sair.

  2. Abra o URL de autenticação gerado no navegador.

  3. Faça login na sua Conta do Google.

  4. Conceda permissão ao Checks para acessar sua conta do Checks.