The SquaredUp CLI

The SquaredUp CLI (squaredup) lets you deploy, update, list, and delete plugins directly from your terminal, without waiting for a branch pipeline. It's the fastest way to iterate during development.

Installation

Use the following commands to install the client. Once installed, the squaredup command will be available from your terminal.

bash

npm install -g @squaredup/cli

# or

 pnpm add -g @squaredup/cli

Authentication

Run the following command to log in:

bash

squaredup login

This opens a browser window where you sign in and authorize the CLI. It's the recommended way to authenticate: no API key to generate or store, and it works on every plan.

To target a specific region:

bash

squaredup login --region eu

Credentials are stored securely in your OS user config directory with owner-only read/write permissions.

To check your current authentication status:

bash

squaredup status

To log out and clear stored credentials:

bash

squaredup logout

Non-interactive login (CI/CD and automation)

For pipelines and scripts where a browser isn't available, authenticate with an API key instead:

bash

squaredup login --apiKey <your-api-key> --region eu

Generate a key from app.squaredup.com > Settings > Advanced > API.

Using the CLI

Once the CLI is installed you can start using it to manage your custom plugins. Using the CLI you can easily deploy a plugin from a folder, list your installed plugins and delete your plugins.

Deploying a plugin

You can deploy either from a .zip file or directly from an unzipped plugin folder. Deploying from a folder is particularly useful during development — you can make quick edits and redeploy without re-exporting from the UI.

Deploying from a zip file:

bash

squaredup deploy plugin.zip

Deploying from an unzipped plugin folder:

Run the following command from within the plugin folder.

If a plugin with the same name and suffix already exists, the CLI will prompt you to confirm whether you want to update the existing deployment.

bash

squaredup deploy --suffix test-v1

Listing deployed plugins

To see all plugins currently deployed to a stage:

bash

squaredup list

This is useful for checking what is currently deployed, validating deployment names, and locating plugin IDs for deletion.

When the plugins are listed, press ENTER on the highlighted entry to copy the ID to your clipboard.

Deleting a plugin

Use an interactive selector to pick the plugin to delete:

bash

squaredup delete

Or delete directly by ID:

bash

squaredup delete <id>

Global flags

Was this article helpful?