Skip to main content
The Square Cloud CLI is a command-line tool to deploy and manage your applications, databases and workspaces from the terminal.

Install

Square Cloud CLI installation
  • Install script: downloads the latest release, verifies it against the release checksums and copies squarecloud to ~/.local/bin (or $SQUARECLOUD_INSTALL_DIR), without sudo. If that folder is not in your PATH, it asks before adding it to your shell’s startup file; without a terminal to ask, it prints the line to add. It works under plain sh and supports x86 (64 and 32-bit), arm64 and ARMv7.
  • PowerShell script: installs on Windows without npm or administrator rights. It verifies the download against the release checksums, copies squarecloud.exe to %LocalAppData%\squarecloud\bin (or $env:SQUARECLOUD_INSTALL_DIR) and adds that folder to your user PATH.
  • .deb and .rpm packages: download the package for your architecture from the latest release, then install it with the command above from the folder that holds it.
  • npm package: needs Node.js and npm, so install a current LTS release of Node.js first. It installs on x64 and arm64 (Apple Silicon, Windows on ARM, Linux) and on ARMv7 Linux. If the binary can’t be downloaded, npm install fails instead of leaving a CLI that can’t run.

Verify a download

Every release lists the SHA-256 of each archive and package in checksums.txt, signed with cosign keyless signing (checksums.txt.sigstore.json). To check a release by hand:

Verify the installation

Open a new terminal and run:
It prints Square Cloud CLI version followed by the installed version. Next, log in with squarecloud auth login.
The folder that holds the CLI is not in your PATH, or the terminal was opened before the install.
  1. Close the terminal and open a new one: a terminal reads PATH only when it starts.
  2. npm: run npm prefix -g. On Windows, the folder it prints (usually %AppData%\npm) must be in your PATH; on macOS and Linux, its bin subfolder must be. Add it in your system settings or shell profile.
  3. Install script: check that ~/.local/bin is in your PATH with echo $PATH. If it is missing, add the line the script printed to your shell profile. If the script warned that another squarecloud comes first in your PATH, remove that older copy.
Check that Node.js and npm are installed with node --version and npm --version. If they are not, install Node.js from nodejs.org, open a new terminal and run the install command again.

Update the CLI

Usage
Downloads the latest release for your system, checks it against the release’s checksums.txt and replaces the binary. On Windows, the running binary is kept as squarecloud.exe.old and deleted on the next run. It doesn’t need a login.
Output
A copy installed with npm or from a .deb or .rpm package belongs to that package manager, so upgrade tells you how to update it instead:
For a package, first download the new one from the latest release. The CLI checks for a newer release at most once a day, only in a terminal, and prints the notice on stderr, so it never mixes with --json output. The notice suggests squarecloud upgrade.

Windows Explorer integration

Usage
integration install adds Send to Square Cloud to the right-click menu of folders and .zip files in Windows Explorer (on Windows 11, under Show more options). It writes under HKEY_CURRENT_USER, so it needs no administrator rights. It points at the squarecloud.exe that ran it: run it again after moving the CLI. integration uninstall removes every key it added. From the menu, a folder whose configuration file has an ID= line is committed to that application, like squarecloud commit. Any other folder or .zip file is uploaded as a new application, like squarecloud upload. A Windows notification shows the result. On macOS and Linux, the command explains that the integration is only available on Windows. A shortcut there takes a few lines:
  • GNOME Files (Nautilus): save this script as ~/.local/share/nautilus/scripts/Send to Square Cloud and make it executable.
  • macOS: in Automator, create a Quick Action that receives folders in Finder and runs the shell script cd "$1" && squarecloud upload, with Pass input set to as arguments.

Language

Messages, help and flag descriptions follow your system language, detected on every run: English, Portuguese, Spanish, German, French, Italian, Japanese and Chinese. The LANGUAGE, LC_ALL, LC_MESSAGES or LANG variable wins when set; otherwise the CLI uses the OS display language (on Windows, the display language, not the regional format). A language without a translation falls back to English. To pick a language for a single run:

Next steps

Quickstart

Deploy your first application from the terminal.

Authentication

Log in from the browser, with an API key or in CI.