Options globales, codes de sortie et 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.

​

Options globales

​

squarecloud status

squarecloud status [--json]

✓ <status message>

​

Débogage

• Définissez SQUARECLOUD_DEBUG=1 pour tracer chaque requête API vers stderr : méthode, chemin, statut et durée. Les en-têtes, les query strings et les corps ne sont jamais journalisés : la sortie peut donc être partagée sans risque.
• Les requêtes de lecture sont relancées automatiquement après une erreur réseau ou lorsque la plateforme est brièvement surchargée.
• Ctrl+C annule la requête en cours ; un second Ctrl+C quitte une commande qui attend une saisie.

SQUARECLOUD_DEBUG=1 squarecloud app list

​

Scripts et CI

• Authentification : définissez SQUARECLOUD_API_KEY au lieu d’exécuter auth login. Consultez Authentification.
• Passez les ID explicitement. Les sélecteurs d’application et de base de données ont besoin d’un terminal. Consultez comment la CLI trouve votre application.
• Codes de sortie : chaque échec se termine avec le code 1, y compris lorsque la CLI a été installée via npm. Vérifiez les codes de sortie, pas le texte des messages.
• Les confirmations refusent par défaut. Si vous répondez non, ou si vous exécutez sans terminal et sans -y une commande qui demande une confirmation, elle se termine avec le code 1 et ne modifie rien. Les commandes qui demandent une confirmation sont app delete, app env replace, app env remove --all, app file delete, app file read -o sur un fichier existant, app network purge-cache, app snapshot restore, db delete, db snapshot restore, db credentials reset, workspace delete, workspace leave, workspace member remove, et auth login lorsqu’elle remplacerait la clé d’un autre compte.
• stdout ne transporte que les résultats. Les erreurs, le message indiquant que vous n’êtes pas connecté, les invites de confirmation, les lignes d’échec et l’avis de mise à jour vont vers stderr. Avec upload --json, les messages de progression vont aussi vers stderr.
• Analysez --json, pas les tableaux. Sur les systèmes qui ne sont pas en anglais, les en-têtes de tableau et les libellés de info sont traduits. Pour forcer l’anglais, exécutez avec LC_ALL=en_US.UTF-8.
• Un état déjà atteint est un succès. Si vous démarrez une application ou une base de données déjà en cours d’exécution, ou arrêtez une ressource déjà arrêtée, la CLI l’indique et se termine avec le code 0.

​

Voir aussi