Skip to main content
1

ログインを開始する

ターミナルでログインコマンドを実行します。
CLI が短いコードを表示し、ブラウザで認可ページを開きます。
2

ブラウザで承認する

ページにコードを入力して承認します。CLI は専用の API キーを受け取り、このマシンに保存します。コピー＆ペーストは不要です。
出力
この方法で発行されたキーには CLI のコマンドが使用する権限のみが付与され、90 日で有効期限が切れます。有効期限の日付は auth whoami で確認できます。更新するには squarecloud auth login をもう一度実行してください。 キーは本人だけが読み取れる config.json ファイルに保存されます。保存先は、Windows では %APPDATA%\Square Cloud CLI、macOS と Linux では $XDG_CONFIG_HOME/squarecloud または ~/.config/squarecloud です。

​
squarecloud auth login

使い方
API キーを使った場合の出力
  • 承認待ちのログインをキャンセルするには Ctrl+C を押します。
  • このマシンがすでに別のアカウントでログインしている場合、auth login は置き換える前に確認を求めます。確認をスキップするには -y を指定します。
  • アカウントが API キーの上限に達している場合、ブラウザでのログインはその旨を表示し、ダッシュボードでキーを失効させるとすぐに自動で続行します。
  • ターミナルがない場合、コマンドは入力を求めず、ヒントを表示して終了します。CI=true の場合、ブラウザでのログインは実行を拒否します。CI とスクリプトを参照してください。

​
squarecloud auth whoami

使い方
ログイン中のアカウント、そのプラン、プランの有効期限までの残り日数を表示します。ブラウザでのログインで発行されたキーの場合は、キーの有効期限とスコープも表示します。キーが SQUARECLOUD_API_KEY から取得されている場合は、代わりにその旨を表示します。
出力
--json を付けると、アカウント（ID、名前、メールアドレス、ロケール、プラン、作成日）を JSON で出力します。

​
squarecloud auth logout

使い方
保存された API キーをこのマシンから削除します。キーは失効しません。失効させるには、ダッシュボードでキーを削除してください。SQUARECLOUD_API_KEY が設定されている場合、ログアウト後もコマンドはそのキーを使い続けます。
出力
アカウントが接続されていない場合は、No account is connected on this machine. と表示してコード 0 で終了します。

​
CI とスクリプト

CI ではログインは不要です。ダッシュボードで API キーを作成し、SQUARECLOUD_API_KEY 環境変数に設定してください。すべてのコマンドが保存済みのキーの代わりにこのキーを使用し、ホームフォルダのないマシンでも CLI が動作します。
  • ターミナルがない場合、auth login は何も入力を求めず、ヒントを表示して終了します。--with-token、--token、または SQUARECLOUD_API_KEY を使用してください。
  • CI=true の場合、ブラウザでのログインは実行を拒否します。そのキーは 90 日で期限切れになり、更新には人による操作が必要だからです。
終了コードと JSON 出力について詳しくは、グローバルフラグと CI を参照してください。

​
キーが機能しなくなった場合

コマンドでセッションの期限切れや API キーの失効が示された場合は、squarecloud auth login をもう一度実行してください。アカウントが必要なコマンドは、キーが保存も設定もされていない場合、You need to be logged in to run this command. と表示して終了コード 1 で終了します。

​
関連項目