Globale Flags, Exit-Codes und 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.

​

Globale Flags

​

squarecloud status

squarecloud status [--json]

✓ <status message>

​

Debugging

• Setze SQUARECLOUD_DEBUG=1, um jede API-Anfrage auf stderr zu protokollieren: Methode, Pfad, Status und Dauer. Header, Query-Strings und Bodys werden nie protokolliert, sodass du die Ausgabe gefahrlos teilen kannst.
• Leseanfragen werden nach einem Netzwerkfehler oder bei kurzzeitiger Überlastung der Plattform automatisch wiederholt.
• Ctrl+C bricht die laufende Anfrage ab; ein zweites Ctrl+C beendet einen Befehl, der auf eine Eingabe wartet.

SQUARECLOUD_DEBUG=1 squarecloud app list

​

Skripte und CI

• Authentifizierung: Setze SQUARECLOUD_API_KEY, statt auth login auszuführen. Siehe Authentifizierung.
• Übergib IDs explizit. Die Auswahllisten für Anwendungen und Datenbanken benötigen ein Terminal. Siehe Wie die CLI deine Anwendung findet.
• Exit-Codes: Jeder Fehler endet mit Code 1, auch wenn die CLI über npm installiert wurde. Prüfe Exit-Codes, nicht den Meldungstext.
• Bestätigungen schlagen sicher fehl. Wer mit Nein antwortet oder einen Befehl mit Bestätigung ohne Terminal und ohne -y ausführt, erhält Exit-Code 1, und nichts wird geändert. Nachfragende Befehle sind app delete, app env replace, app env remove --all, app file delete, app file read -o über eine vorhandene Datei, app network purge-cache, app snapshot restore, db delete, db snapshot restore, db credentials reset, workspace delete, workspace leave, workspace member remove und auth login, wenn es den Schlüssel eines anderen Kontos ersetzen würde.
• stdout enthält nur Ergebnisse. Fehler, die Meldung “not logged in”, Bestätigungsabfragen, Fehlerzeilen und der Update-Hinweis gehen nach stderr. Mit upload --json gehen auch Fortschrittsmeldungen nach stderr.
• Werte --json aus, nicht Tabellen. Auf nicht englischen Systemen werden Tabellenköpfe und info-Beschriftungen übersetzt. Um Englisch zu erzwingen, führe die CLI mit LC_ALL=en_US.UTF-8 aus.
• Bereits im Zielzustand gilt als Erfolg. Das Starten einer laufenden Anwendung oder Datenbank oder das Stoppen einer gestoppten wird gemeldet und endet mit Code 0.

​

Siehe auch