グローバルフラグ、終了コード、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.

​

グローバルフラグ

​

squarecloud status

squarecloud status [--json]

✓ <status message>

​

デバッグ

• SQUARECLOUD_DEBUG=1 を設定すると、すべての API リクエストが stderr にトレースされます（メソッド、パス、ステータス、所要時間）。ヘッダー、クエリ文字列、ボディは記録されないため、出力を安全に共有できます。
• 読み取りリクエストは、ネットワークエラーの後やプラットフォームが一時的に混雑しているときに、自動で再試行されます。
• Ctrl+C を押すと、実行中のリクエストをキャンセルします。入力待ちのコマンドは、もう一度 Ctrl+C を押すと終了します。

SQUARECLOUD_DEBUG=1 squarecloud app list

​

スクリプトと CI

• 認証: auth login を実行する代わりに SQUARECLOUD_API_KEY を設定します。認証を参照してください。
• ID を明示的に渡してください。 アプリケーションやデータベースの選択画面にはターミナルが必要です。CLI がアプリを特定する仕組みを参照してください。
• 終了コード: npm 経由でインストールした場合を含め、すべての失敗はコード 1 で終了します。メッセージのテキストではなく、終了コードを確認してください。
• 確認は安全側に倒れます。 「いいえ」と答えた場合や、確認を求めるコマンドをターミナルなし、かつ -y なしで実行した場合は、コード 1 で終了し、何も変更されません。確認を求めるコマンドは app delete、app env replace、app env remove --all、app file delete、既存ファイルに対する app file read -o、app network purge-cache、app snapshot restore、db delete、db snapshot restore、db credentials reset、workspace delete、workspace leave、workspace member remove、そして別のアカウントのキーを置き換えることになる場合の auth login です。
• stdout には結果のみが出力されます。 エラー、未ログインのメッセージ、確認プロンプト、失敗を示す行、更新通知は stderr に出力されます。upload --json では、進行状況のメッセージも stderr に出力されます。
• テーブルではなく --json を解析してください。 英語以外のシステムでは、テーブルの見出しと info のラベルが翻訳されます。英語に固定するには、LC_ALL=en_US.UTF-8 を指定して実行してください。
• すでにその状態であれば成功です。 実行中のアプリケーションやデータベースを起動したり、停止中のものを停止したりすると、その旨を表示してコード 0 で終了します。

​

関連項目