CLI Cheatsheet

This guide provides a quick reference to the commands needed to launch the squid and manage the database.

Initial Setup

Before running the squid, install all project dependencies:

npm i

npx tsc

Start a local PostgreSQL database to store the data (the template includes a Docker Compose file):

docker compose up -d

Apply database migrations to create the target schema:

npx squid-typeorm-migration apply

For detailed information on migrations, see TypeORM Migration generation. Run the indexer:

node -r dotenv/config lib/main.js

Inspect the indexed contracts directly in the database:

docker exec "$(basename "$(pwd)")-db-1" psql -U postgres \
  -c "SELECT id, logs_count, found_at FROM contract ORDER BY logs_count desc LIMIT 10"

You can use the sqd utility to shorten these commands and manage their interrelations — see commands.json.

Learn the general development workflow

Complete CLI documentation

⌘I