Skip to main content
このガイドでは、手元のプロジェクトを Square Cloud 上で動くアプリケーションにし、その後の変更を反映する方法までを説明します。所要時間は数分です。
1

CLI をインストールする

squarecloud --version で動作を確認します。コマンドが見つからない場合は、インストールを参照してください。
2

ログインする

CLI が短いコードを表示し、ブラウザで認証ページを開きます。そのページでコードを入力して承認してください。API キーや CI での使い方は認証ページで説明しています。
3

設定ファイルを追加する

プロジェクトのルートに squarecloud.app ファイルを作成します。このファイルで、実行するファイル、確保するメモリ量、使用するランタイムのバージョンを Square Cloud に伝えます。
squarecloud.app
Web サイトの場合は SUBDOMAIN=<name> を追加すると、<name>.squareweb.app で公開されます。各キーの説明は設定ファイルのガイドにあります。
4

プロジェクトをアップロードする

プロジェクトのフォルダで次を実行します。
CLI はフォルダを zip にまとめ（squarecloud.ignore に記載されたものと、デフォルトで除外される node_modules、.git、ロックファイルは含めません）、新しいアプリケーションを作成します。
出力
さらに、新しいアプリケーションの ID を設定ファイルに書き込むため、以降のコマンドはどのアプリを指しているかを判断できます。
squarecloud.app
5

動作を確認する

ID の指定は不要です。どちらも ID= 行を読み取ります。出力をリアルタイムで追うには squarecloud app realtime を実行し、止めるときは Ctrl+C を押します。
6

変更を反映する

コードを編集したら、フォルダを同じアプリケーションに送信して再起動します。
upload は実行するたびに新しいアプリケーションを作成します。commit は既存のアプリケーションを更新し、その ID、ドメイン、設定を維持します。

​
CLI がアプリを特定する仕組み

1 つのアプリケーションを操作するコマンドは、使い方に [appID] と表示されます。この ID は省略できます。CLI は次の順序でアプリケーションを決定します。
  1. 指定した ID。 最初の引数として渡すか、引数が別の用途に使われるコマンドでは --app <appID> で渡します。対象は app env set、remove、replace、すべての app file コマンド、app deploy webhook、app deploy github link と unlink、app network domain です。
  2. 現在のフォルダにある squarecloud.app ファイル（または squarecloud.config。両方ある場合は squarecloud.app が優先されます）の ID= 行。
  3. CLI がターミナルで実行されている場合に表示される、アプリケーションの一覧から選ぶ選択画面。矢印キーと Enter で選び、Esc でキャンセルします。
一部のコマンドは動作が異なります。
  • commit は選択画面を開きません。引数も ID= 行もない場合は、終了コード 1 で停止し、ID の指定を求めます。
  • app snapshot restore は、常に最初の引数としてアプリケーション ID を受け取ります。
  • データベースには設定ファイルがないため、db コマンドはデータベース ID を受け取るか、データベースの選択画面を開きます。
  • ワークスペースを操作する workspace コマンドは、常にその ID を受け取ります。
ID を調べるには squarecloud app list を実行します。スクリプトや CI では、選択画面に対話型ターミナルが必要なため、必ず ID を渡すか ID= 行を残しておいてください。

​
アプリ ID の保存場所

upload が ID=<appID> を書き込むのは、フォルダにすでに設定ファイルがある場合だけです（設定ファイルはアップロードにも必要です）。変更するのはその 1 行だけで、ほかのキーやコメントはそのまま残ります。Square Cloud はファイルを読み込むときにこの行を無視するため、zip に含めたままでも問題ありません。 同じフォルダで upload を再度実行すると、別のアプリケーションが作成され、ID= 行はそちらを指すようになります。既存のアプリケーションを更新するには commit を使ってください。このフォルダから別のアプリケーションを操作したい場合は、この行を編集するか削除します。

​
次のステップ

アップロードとコミット

upload、commit、zip のすべてのフラグと、zip に含まれる内容。

環境変数

ターミナルから変数を設定したり、.env ファイルから読み込んだりします。

GitHub デプロイ

Square Cloud GitHub App を通じて、push のたびにデプロイします。

グローバルフラグと CI

JSON 出力、終了コード、パイプラインでの CLI の実行。