> ## Documentation Index
> Fetch the complete documentation index at: https://docs.squarecloud.app/llms.txt
> Use this file to discover all available pages before exploring further.

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

> Use as flags globais da CLI da Square Cloud, a saída em JSON, os códigos de saída e o modo debug, confira a saúde da plataforma e rode a CLI em scripts e CI.

## `squarecloud help`

```bash Uso theme={"system"}
squarecloud help [command]
squarecloud [command] --help
```

Lista todos os comandos ou explica um deles. A ajuda segue o [idioma do seu sistema](/pt-br/cli-reference/installation#idioma).

```bash Saída theme={"system"}
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

| Flag | Descrição |
| - | - |
| `--json` | Imprime JSON bruto, legível por máquina, nos comandos que imprimem dados (`list`, `info`, `status`, `logs`, `auth whoami`, `upload`, ...). Os comandos sem saída em JSON (`app start`, `app delete`, `commit`, `zip`, ...) recusam a flag com um erro. |
| `-h`, `--help` | Mostra a ajuda de qualquer comando. |
| `-v`, `--version` | Imprime a versão da CLI. Só no próprio `squarecloud`. |

Os comandos destrutivos também aceitam `-y`/`--yes` para pular a confirmação `y/N`. A página de cada comando indica quando.

## `squarecloud status`

```bash Uso theme={"system"}
squarecloud status [--json]
```

Confere se a plataforma da Square Cloud está operando normalmente. Funciona sem login. Para uma aplicação ou um banco de dados, use [`squarecloud app status`](/pt-br/cli-reference/status-and-metrics#squarecloud-app-status) ou [`squarecloud db status`](/pt-br/cli-reference/databases#squarecloud-db-status).

```bash Saída theme={"system"}
✓ <status message>
```

Quando a plataforma informa um problema, a linha começa com `X`. Veja também a [página de status](https://status.squarecloud.app/).

## 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.

```bash theme={"system"}
SQUARECLOUD_DEBUG=1 squarecloud app list
```

## Scripts e CI

A CLI se comporta de forma previsível quando roda sem uma pessoa no teclado:

* **Autenticação:** defina `SQUARECLOUD_API_KEY` em vez de executar o `auth login`. Veja [Autenticação](/pt-br/cli-reference/authentication#ci-e-scripts).
* **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](/pt-br/cli-reference/quickstart#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`.

Para fazer deploy pelo GitHub Actions, veja o [workflow de deploy automático](https://help.squarecloud.app/pt-br/article/workflow-github-actions-deploy-automatico-o6c7e2/) na central de ajuda.

## Relacionados

| Comando | API | SDK JavaScript |
| - | - | - |
| `status` | [`GET /v2/service/status`](/pt-br/api-reference/endpoint/service/status) | [`api.service.status()`](/pt-br/sdks/js/client) |