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.

Inspect the available options with

npx 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

Subcommands for squid command​

SubcommandDescriptionArguments
createCreate a squid

[NAME] squid name (optional)

-d, --description description

-l, --logo logo URL

-w, --website website URL

killKill a squid or a squid version[NAMEANDVERSION] squid name or name@version
lsSquid or versions list

-n, --name= squid name

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

releaseCreate a version

[NAMEANDVERSION] squid name and version name@version

-d, --description= description

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

logsGetting logs about version

[NAMEANDVERSION] squid name and version 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)

updateUpdate a version image

[NAMEANDVERSION] squid name and versionname@version

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

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

Examples​

Create a new squid​

sqd squid create squid-test

Kill a squid 😭 (and all its versions)​

sqd squid kill squid-test

List squids​

npx sqd squid ls

List versions of a squid​

npx sqd squid ls -n squid-test

Release the kraken!​

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

Show logs of a squid​

npx sqd squid logs squid-test@1 -f

Update a version with new code​

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