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:- Linux
- Mac
- Windows
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.Squid CLI
Squid CLI is a command-line tool for scaffolding, managing, and deploying squids. Install it globally:Verify the installation by running
sqd --version.Git
Squid CLI uses Git to retrieve templates. Install Git for your platform:- Linux
- Mac
- Windows
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.- Linux
- Mac
- Windows
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

