Skip to main content

​
Development Environment Setup

This guide will help you set up all the necessary tools for developing with Squid SDK.

​
Prerequisites

You’ll need to install the following tools to start building blockchain indexers with Squid SDK.

​
Node.js

Node.js is required to run Squid SDK. Install Node.js v16 or newer:
Use your distribution’s package manager or the official binaries.
Verify your Node.js installation by running node --version. You should see v16.0.0 or higher.
node --version

​
Squid CLI

Squid CLI is a command-line tool for scaffolding, managing, and deploying squids. Install it globally: 
npm i -g @subsquid/cli
Verify the installation by running sqd --version.
For detailed installation instructions and troubleshooting, see the CLI installation guide.

​
Git

Squid CLI uses Git to retrieve templates. Install Git for your platform:
Use your distribution’s package manager (e.g., apt install git or yum install git).
Verify Git installation by running git --version.

​
Docker

Most squids use a database to store processed data. Docker makes it easy to run PostgreSQL locally for development.
UbuntuFollow the official installation guide for Ubuntu.Other Linux distributionsUse your distribution’s package manager or follow the official Docker installation guide.
Verify Docker installation by running docker --version.

​
Next Steps

With your environment set up, you’re ready to start building:

Quickstart

Build your first indexer in 5 minutes

Indexer from Scratch

Learn how to compose SDK packages