Skip to main content
Version: Firesquid

Squid CLI

The squid topic of the sqd command line interface is used to manage the deployment of your projects to Aquarium, a cloud service for running squids.

Subcommands for squid command​

Inspect the available options with

sqd squid --help

It allows to

  • create a new squid
  • list deployed squids and versions
  • deploy new versions for a squid
  • update existing squids or squid versions
  • kill a deployed squid
  • monitor the logs of a squid
SubcommandDescriptionArguments
createCreate a squid

[NAME] squid name

-d, --description description

-l, --logo logo URL

-w, --website website URL

killKill a squid or a squid version[NAMEANDVERSION] squid name and version formatted as name@version. If only name is provided, all the squid versions are deleted.
lsList all squids or show details for a specific squid

-n, --name= squid name (optional)

-t, --truncate truncate data in columns (false by default)

releaseDeploy a squid version

[NAMEANDVERSION] squid name and version, formatted as name@version

-d, --description= description

-s, --source= git URL of the source code

-e (allows multiple) a set of environment variable to be set for the squid processor

--envFile local file with environment variables

logsGet squid logs

[NAMEANDVERSION] squid name and version formatted as name@version

-c, --container output logs only from a specific squid component (processor|query-node|db-migrate)

-f, --follow continue streaming new logs

-l, --level set logs level (error|debug|info|warning)

-p, --pageSize set logs page size (default: 50)

--since logs start date (default: 1d)

updateRedeploy a squid version

[NAMEANDVERSION] squid name and version formatted as name@version

-r, --hardReset perform a hard reset (db wipe out)

-s, --source= git URL of the source code

-e (allows multiple) a set of environment variables to be set for the squid processor

--envFile local file with environment variables

prodPromote a squid version to the production endpoint

[NAMEANDVERSION] squid name and version formatted as name@version

Secrets​

CommandDescriptionArguments
secrets:lsList all secrets
secrets:rm [NAME]Delete a secretsecret name
secrets:set [NAME] [VALUE]Create or update a secretsecret name, secret value

Examples​

Create a new squid​

sqd squid create squid-test

Kill a squid 😭 (and all its versions)​

sqd squid kill squid-test

List squids​

 sqd squid ls

List versions of a squid​

npx sqd squid ls -n squid-test

Release the kraken!​

sqd squid:release squid-test@1 --source=git@github.com:subsquid/squid-template.git

Show logs of a squid​

sqd squid logs squid-test@1 -f

Promote a version to production​

sqd squid:prod squid-test@1

Update a version with new code​

npx sqd squid release squid-test@1 -r -s git@github.com:subsquid/squid-template.git