Skip to main content
1

Inicie o login

Execute o comando de login no seu terminal:
A CLI mostra um código curto e abre a página de autorização no seu navegador.
2

Aprove no navegador

Digite o código na página e aprove. A CLI recebe a própria chave de API, sem precisar copiar e colar nada, e a salva nesta máquina.
Saída
Uma chave emitida dessa forma tem apenas as permissões que os comandos da CLI usam e expira após 90 dias. O auth whoami mostra a data; execute squarecloud auth login novamente para renová-la. A chave fica salva em um arquivo config.json que só você pode ler: em %APPDATA%\Square Cloud CLI no Windows, e em $XDG_CONFIG_HOME/squarecloud ou ~/.config/squarecloud no macOS e no Linux.

​
squarecloud auth login

Uso
Saída com uma chave de API
  • Pressione Ctrl+C para cancelar um login que está aguardando aprovação.
  • Se esta máquina já estiver conectada a outra conta, o auth login pergunta antes de substituí-la. Passe -y para pular a pergunta.
  • Se a sua conta atingiu o limite de chaves de API, o login pelo navegador avisa e continua sozinho assim que você revogar uma chave no dashboard.
  • Sem um terminal, o comando não pede nada: ele sai com uma dica. Com CI=true, o login pelo navegador se recusa a rodar. Veja CI e scripts.

​
squarecloud auth whoami

Uso
Mostra a conta em que você está logado, o plano dela e quantos dias faltam para o plano expirar. Para uma chave emitida pelo login no navegador, também mostra quando a chave expira e os escopos dela; quando a chave vem da SQUARECLOUD_API_KEY, avisa isso no lugar.
Saída
Com --json, imprime a conta (ID, nome, e-mail, idioma, plano e data de criação) em JSON.

​
squarecloud auth logout

Uso
Remove a chave de API salva desta máquina. Ele não revoga a chave: para isso, exclua-a no dashboard. Quando a SQUARECLOUD_API_KEY está definida, os comandos continuam a usá-la depois de um logout.
Saída
Quando nenhuma conta está conectada, ele imprime No account is connected on this machine. e sai com código 0.

​
CI e scripts

No CI, não faça login: crie uma chave de API no dashboard e defina-a na variável de ambiente SQUARECLOUD_API_KEY. Todo comando a usa no lugar da chave salva, e a CLI funciona até em máquinas sem pasta home.
  • Sem um terminal, o auth login não pede nada: ele sai com uma dica. Use --with-token, --token ou SQUARECLOUD_API_KEY.
  • Com CI=true, o login pelo navegador se recusa a rodar, já que a chave dele expira em 90 dias e só uma pessoa pode renová-la.
Veja mais sobre códigos de saída e saída em JSON em Flags globais e CI.

​
Quando a chave para de funcionar

Se um comando disser que a sua sessão expirou ou que a chave de API foi revogada, execute squarecloud auth login novamente. Os comandos que precisam de uma conta imprimem You need to be logged in to run this command. e saem com código 1 quando nenhuma chave está salva ou definida.

​
Relacionados