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

Compiling the Project

npx tsc

Running the Squid

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

Checking Out the Indexed Data

Inspect the indexed swaps directly in the database:

docker exec "$(basename "$(pwd)")-db-1" psql -U postgres \
  -c "SELECT slot, from_token, to_token, from_amount, to_amount FROM exchange ORDER BY id LIMIT 10"

The Solana example project doesn’t utilize sqd commands. You can use the sqd utility to shorten the commands above and manage their interrelations — see commands.json.

Next Steps

Development Flow

Learn the general development workflow

Full CLI Reference

Complete CLI documentation

Development Environment Setup

Multichain Indexing

⌘I

Pipes SDK

Squid SDK

Initial Setup

Compiling the Project

Running the Squid

Checking Out the Indexed Data

Next Steps

Development Flow

Full CLI Reference

​Initial Setup

​Compiling the Project

​Running the Squid

​Checking Out the Indexed Data

​Next Steps

Development Flow

Full CLI Reference

Initial Setup

Compiling the Project

Running the Squid

Checking Out the Indexed Data

Next Steps