> ## Documentation Index
> Fetch the complete documentation index at: https://docs.squarecloud.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Install the Square Cloud CLI

> Install the Square Cloud CLI on macOS, Linux, WSL or Windows with one command, check that it runs, update it and choose the language of its messages.

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

## Install

<Frame>
  <img src="https://cdn.squarecloud.app/docs/cli/install.gif" alt="Square Cloud CLI installation" />
</Frame>

<CodeGroup>
  ```bash macOS, Linux and WSL theme={"system"}
  curl -fsSL https://cli.squarecloud.app/install | bash
  ```

  ```bash Windows with npm theme={"system"}
  npm install -g @squarecloud/cli
  ```
</CodeGroup>

* **Install script:** downloads the latest release, verifies it against the release checksums and copies `squarecloud` to `/usr/local/bin`, using `sudo` when you are not root. It works under plain `sh` and supports x86 (64 and 32-bit), arm64 and ARMv7. On Windows, run it inside WSL, or use npm.
* **npm package:** needs [Node.js](https://nodejs.org/) 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 the installation

Open a new terminal and run:

```bash theme={"system"}
squarecloud --version
```

It prints `Square Cloud CLI version` followed by the installed version. Next, log in with [`squarecloud auth login`](/en/cli-reference/authentication).

<AccordionGroup>
  <Accordion title="squarecloud: command not found">
    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 `/usr/local/bin` is in your `PATH` with `echo $PATH`, and add it to your shell profile if it is missing.
  </Accordion>

  <Accordion title="npm install fails on Windows">
    Check that Node.js and npm are installed with `node --version` and `npm --version`. If they are not, install Node.js from [nodejs.org](https://nodejs.org/), open a new terminal and run the install command again.
  </Accordion>
</AccordionGroup>

## Update the CLI

Run the install command again:

<CodeGroup>
  ```bash macOS, Linux and WSL theme={"system"}
  curl -fsSL https://cli.squarecloud.app/install | bash
  ```

  ```bash Windows with npm theme={"system"}
  npm install -g @squarecloud/cli@latest
  ```
</CodeGroup>

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.

## 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:

```bash theme={"system"}
LC_ALL=pt_BR squarecloud --help
```

## Next steps

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/en/cli-reference/quickstart">
    Deploy your first application from the terminal.
  </Card>

  <Card title="Authentication" icon="lock" href="/en/cli-reference/authentication">
    Log in from the browser, with an API key or in CI.
  </Card>
</CardGroup>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.