Global flags, exit codes and 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.

​

Global flags

​

squarecloud status

squarecloud status [--json]

✓ <status message>

​

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.
• Ctrl+C cancels the request in flight; a second Ctrl+C exits a command that is waiting for input.

SQUARECLOUD_DEBUG=1 squarecloud app list

​

Scripts and CI

• 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, 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.
• 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.

​

Related