Creating a squid project

New squid projects are scaffolded with the sqd init command of Squid CLI:

sqd init NAME

NAME becomes the project folder name; it must contain only alphanumeric or dash (-) symbols and must not start with -. The command runs interactively by default. To skip the prompts, pass a template and --no-interactive:

sqd init my-squid --template evm --no-interactive

Templates

The -t, --template flag accepts either of:

a GitHub repository URL containing a valid squid.yaml manifest in the root folder, or
one of the pre-defined aliases:

Alias	Description
`evm`	A minimal squid template for indexing EVM data
`abi`	A template to auto-generate a squid indexing events and txs from a contract ABI
`multichain`	A template for indexing data from multiple chains
`gravatar`	A sample EVM squid indexing the Gravatar smart contract on Ethereum
`substrate`	A template squid for indexing Substrate-based chains
`ink`	A template for indexing ink! smart contracts
`ink-abi`	A template to auto-generate a squid from an ink! contract ABI
`frontier-evm`	A template for indexing Frontier EVM chains, like Moonbeam and Astar

The aliases above are for EVM and Substrate squids. Solana squids scaffold from the example repository URL, as in the Solana quickstart:

sqd init my-squid -t https://github.com/subsquid-labs/solana-example

Use -d, --dir to place the squid somewhere other than a new NAME folder.

The -r, --remove flag deletes the existing target directory before creating the project. Use it only when that directory can be replaced.

See the sqd init command reference for the full list of flags.

Next steps

After scaffolding, enter the project folder and install the dependencies:

cd my-squid
npm i

Then follow the Quickstart to run the squid locally, or see Make an indexer for the full development flow.

Overview

Pipes SDK

Squid SDK

Alternative clients

Templates

Next steps

​Templates

​Next steps

Templates

Next steps