Manage applications from the CLI

List your Square Cloud applications, show their details, start, stop or restart them and delete the ones you no longer need with squarecloud app.

[appID] is optional in every command on this page except list: see how the CLI finds your app.

squarecloud app list

Usage

squarecloud app list [--json]

Prints a table of every application in your account: name, app ID, memory, cluster, language and domain (the custom domain when there is one).

squarecloud app list --json
# Prints the raw application list as JSON.

squarecloud app info

Usage

squarecloud app info [appID] [--json]

Shows the application ID, name, description, language, memory, cluster, owner, domain, custom domain and creation date.

squarecloud app info <appID> --json
# Prints the raw application object as JSON.

squarecloud app start

Usage

squarecloud app start [appID]

Starts a stopped application.

Output

✓ Signal START has been successfully sent to your application.

If the application is already running, the CLI says so (It is already running.) and exits with code 0. Other refusals from the platform are reported as errors.

squarecloud app stop

Usage

squarecloud app stop [appID]

Stops a running application. If it is already stopped, the CLI says so (It is already stopped.) and exits with code 0.

squarecloud app restart

Usage

squarecloud app restart [appID]

Restarts the application’s process. To send new code and restart in one step, use squarecloud commit --restart.

squarecloud app delete

Usage

squarecloud app delete [appID] [-y]

Flag	Description
-y, --yes	Skips the confirmation prompt.

Deleting an application is permanent, and the CLI doesn’t take a snapshot first. To keep a copy, run squarecloud app snapshot create --download before deleting.

Asks Delete the application <appID>? This action is irreversible [y/N] before deleting. Without an ID, the command targets the application in the ID= line of the current folder, so check the ID in the question.

squarecloud app delete <appID> -y
# Deletes without asking, for scripts.

Output

✓ Your application has been deleted.

Related

Command	API	JavaScript SDK	VS Code
list	GET /v2/users/me	api.account.me()	Side bar
info	GET /v2/apps/{app_id}	api.apps.get()	Click an application card
start	POST .../start	api.apps.start()	Start
stop	POST .../stop	api.apps.stop()	Stop
restart	POST .../restart	api.apps.restart()	Restart
delete	DELETE /v2/apps/{app_id}	api.apps.delete()	Delete