Skip to main content

squarecloud help

Usage
Lists every command, or explains one. Help follows your system language.
Output

Global flags

Destructive commands also accept -y/--yes to skip their y/N confirmation. The pages of each command list it.

squarecloud status

Usage
Checks whether the Square Cloud platform is operating normally. It works without logging in. For one application or database, use squarecloud app status or squarecloud db status.
Output
The line starts with ✓ when the platform is online, ⚠ during maintenance or degradation, and ? when the check itself could not run, which does not mean the platform is down. Below it, the CLI lists the open incidents (title, status, start and expected end) and the affected components. See also the status page.

Debugging

  • Set SQUARECLOUD_DEBUG=1 to trace every API request to stderr: method, path, status and duration. Headers, query strings and bodies are never logged, so the output is safe to share.
  • Read requests are retried automatically after a network error or when the platform is briefly busy.
  • Errors you can act on come with a hint that says what to do: an expired or revoked key, a key without the permission the command needs, too many requests, a snapshot restore or a snapshot already running, another change to the environment variables in progress, snapshots temporarily unavailable, and a server under maintenance.
  • Ctrl+C cancels the request in flight; a second Ctrl+C exits a command that is waiting for input.

Scripts and CI

The CLI behaves predictably when it runs without a person at the keyboard:
  • Authentication: set SQUARECLOUD_API_KEY instead of running auth login. See Authentication.
  • Pass IDs explicitly. The application and database pickers need a terminal. See how the CLI finds your app.
  • Exit codes: every failure exits with code 1, including when the CLI was installed through npm. Check exit codes, not message text.
  • Confirmations fail closed. Answering no, or running a command that asks for confirmation without a terminal and without -y, exits with code 1 and changes nothing. The commands that ask are app delete, app env replace, app env remove --all, app file delete, app file read -o over an existing file, app network purge-cache, app snapshot restore, blob delete, db delete, db snapshot restore, db credentials reset, workspace delete, workspace leave, workspace member remove, and auth login when it would replace another account’s key.
  • stdout carries only results. Errors, the “not logged in” message, confirmation prompts, failure lines and the update notice go to stderr. With upload --json, progress messages go to stderr too, and blob upload always sends its progress there.
  • Parse --json, not tables. On non-English systems, table headers and info labels are translated. To force English, run with LC_ALL=en_US.UTF-8.
  • Already in that state is success. Starting a running app or database, or stopping a stopped one, says so and exits with code 0.
To deploy from GitHub Actions, see the help center’s automated deploy workflow.