Pular para o conteúdoLockpick
Documentação

Instale e faça login

Instale a CLI do Lockpick pelo npm e faça login pelo terminal, com o seu navegador.

A CLI do Lockpick permite que você e o seu assistente de programação usem o Lockpick a partir de um terminal. Ela precisa do Node.js 20.9 ou mais recente.

Instale

Terminal
npm install -g lockpicks

O pacote é lockpicks, com s, e ele instala um comando lockpick. Você também pode executá-lo sem instalar, com npx lockpicks.

Faça login

Terminal
lockpick login --host https://www.lockpick.app

O trecho indica este servidor do Lockpick com --host. Não há um host padrão embutido. A CLI usa o --host, depois o LOCKPICK_HOST e depois o seu perfil salvo. Depois do primeiro login, o lockpick login pode reutilizar esse perfil.

O seu navegador abre e pede que você aprove o login. A chave vai direto para o seu terminal, e você nunca precisa copiá-la à mão.

Por padrão, a chave pode ler os seus sites e relatórios. Peça mais permissões ao fazer login.

  • --pulse permite iniciar verificações Pulse, verificações rápidas e a leitura gratuita Reler este registro.
  • --sites permite adicionar sites, trocar o seu site gratuito e enviar as versões dos seus pacotes para o Monitor.
  • --deep permite preparar verificações Deep, que você ainda aprova no Lockpick.
  • --no-browser imprime o endereço de login em vez de abri-lo.

Confira com quem você está conectado usando lockpick whoami, e saia com lockpick logout, que também revoga a chave.

Os seus primeiros comandos

Terminal
lockpick whoami
lockpick sites
lockpick status

Esses comandos leem a sua conta e os resultados existentes sem iniciar uma verificação. Rode lockpick doctor se a conexão não estiver funcionando.

Para iniciar uma verificação, faça login com --pulse e use um site que você possui ou tem autorização para testar. atlas.example é um endereço de exemplo, não um alvo de teste real. Iniciar uma verificação usa a cota mostrada pelo Lockpick; ler o status ou o relatório dela não usa outra verificação.

Todo comando aceita --json para scripts e --help para ver as suas opções. Comandos lista todos eles.

Códigos de saída

CódigoSignificado
0Funcionou
1Algo deu errado, ou o que você pediu não foi encontrado
2Você precisa fazer login
3A verificação que você esperou não teve sucesso, ou ainda está rodando
4A sua chave ou o seu papel não permite isso, ou a sua cota acabou
5O comando ou um dos seus valores não é válido
6Requisições demais; espere e tente de novo
7O Lockpick ou um provedor que ele usa está ocupado ou indisponível
8Os achados abertos atingiram o --fail-on (Rode o Lockpick no CI)

Os erros terminam com um link para a página que os explica. O lockpick doctor verifica a sua configuração, e lockpick docs <words> pesquisa esta documentação a partir do seu terminal.

Isto foi útil?

Nesta página