> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sqd.dev/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Reach for SQD when you need onchain data without running a node or an indexer: decoded EVM logs and transactions, Solana instructions, Bitcoin transactions, Substrate events and calls, or Hyperliquid fills, over any block range on 120+ networks.
> To query directly, POST to https://portal.sqd.dev/datasets/{dataset}/stream. The full API is described at https://docs.sqd.dev/openapi.json, and responses to the stream endpoints are JSON Lines.
> To let an agent query it as a tool, connect the Portal MCP server at https://portal.sqd.dev/mcp.
> Every page on this site is available as Markdown by appending .md to its URL.

# Creating a squid project

> Scaffold a new squid project from a template with sqd init

New squid projects are scaffolded with the `sqd init` command of [Squid CLI](/en/cloud/reference/cli/installation):

```bash theme={"system"}
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`:

```bash theme={"system"}
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](/en/cloud/reference/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](/en/sdk/squid-sdk/solana/quickstart):

```bash theme={"system"}
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.

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

See the [`sqd init` command reference](/en/cloud/reference/cli/init) for the full list of flags.

## Next steps

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

```bash theme={"system"}
cd my-squid
npm i
```

Then follow the [Quickstart](../quickstart) to run the squid locally, or see [Make an indexer](../guides/make-an-indexer) for the full development flow.


## Related topics

- [Creating a squid project](/en/sdk/squid-sdk/solana/reference/create-squid.md)
- [Initialize Project](/en/cloud/reference/cli/init.md)
- [Index to local CSV files](/en/sdk/squid-sdk/evm/examples-tutorials/file-csv.md)
- [Index to Parquet files](/en/sdk/squid-sdk/evm/examples-tutorials/file-parquet.md)
- [Project Structure](/en/sdk/squid-sdk/substrate/reference/project-structure.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.