Skip to main content
Squid CLI is a command line tool for
  • scaffolding new squids from templates
  • running SDK tools and scripts defined in commands.json in a cross-platform way
  • managing squid deployments in SQD Cloud (former Aquarium)
The CLI is distributed as a npm package. To install Squid CLI, follow the steps below.
1

Install Squid CLI

First, install the latest version of Squid CLI as a global npm package:
Check the version:
The command prints the installed CLI version.
The next steps are optional for building and running squids. A key is required to enable the CLI commands managing the SQD Cloud deployments.
2

Obtain a SQD Cloud deployment key

Sign in to SQD Cloud, then open Deployment key from the profile menu to obtain or refresh the key:
SQD Cloud deployment key page
3

Authenticate Squid CLI

Open a terminal window and run
4

Explore with `--help`

Use sqd --help to list available commands and sqd <command> --help to inspect a specific command. For example: