Flags globais, códigos de saída e CI

​

squarecloud help

squarecloud help [command]
squarecloud [command] --help

A command line application to manage your Square Cloud applications

Usage:
  squarecloud COMMAND [flags]
  squarecloud [command]

Available Commands:
  app         Manage your applications with these commands
  auth        Manage your Square Cloud login with these commands
  commit      Make a commit for your application
  db          Manage the databases of your account
  help        Help about any command
  status      Check the Square Cloud platform health
  upload      Upload a new application
  workspace   Manage your team workspaces
  zip         Zip the current folder

Flags:
  -h, --help      Show help for this command
      --json      Output raw JSON
  -v, --version   Print the CLI version

Use "squarecloud [command] --help" for more information about a command.

​

Flags globais

​

squarecloud status

squarecloud status [--json]

✓ <status message>

​

Depuração

• Defina SQUARECLOUD_DEBUG=1 para registrar cada requisição à API no stderr: método, caminho, status e duração. Cabeçalhos, query strings e corpos nunca são registrados, então a saída é segura para compartilhar.
• As requisições de leitura são repetidas automaticamente após um erro de rede ou quando a plataforma está ocupada por alguns instantes.
• Ctrl+C cancela a requisição em andamento; um segundo Ctrl+C encerra um comando que está aguardando uma resposta sua.

SQUARECLOUD_DEBUG=1 squarecloud app list

​

Scripts e CI

• Autenticação: defina SQUARECLOUD_API_KEY em vez de executar o auth login. Veja Autenticação.
• Passe os IDs explicitamente. Os seletores de aplicação e de banco de dados precisam de um terminal. Veja como a CLI encontra sua aplicação.
• Códigos de saída: toda falha sai com código 1, inclusive quando a CLI foi instalada pelo npm. Confira os códigos de saída, não o texto das mensagens.
• Confirmações falham de forma segura. Responder não, ou rodar sem terminal e sem -y um comando que pede confirmação, sai com código 1 e não altera nada. Os comandos que pedem confirmação são app delete, app env replace, app env remove --all, app file delete, app file read -o sobre um arquivo existente, app network purge-cache, app snapshot restore, db delete, db snapshot restore, db credentials reset, workspace delete, workspace leave, workspace member remove e o auth login quando ele substituiria a chave de outra conta.
• O stdout traz só resultados. Erros, a mensagem de “não logado”, as perguntas de confirmação, as linhas de falha e o aviso de atualização vão para o stderr. Com upload --json, as mensagens de progresso também vão para o stderr.
• Leia o --json, não as tabelas. Em sistemas que não estão em inglês, os cabeçalhos das tabelas e os rótulos do info são traduzidos. Para forçar o inglês, rode com LC_ALL=en_US.UTF-8.
• Já estar no estado pedido é sucesso. Iniciar uma aplicação ou um banco de dados que já está rodando, ou parar um que já está parado, avisa e sai com código 0.

​

Relacionados