> ## 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.

# Initialize Project

> Initialize a new squid project from a template with sqd init.

Setup a new squid project from a template or github repo

* [`sqd init NAME`](#sqd-init-name)

## `sqd init NAME`

Setup a new squid project from a template or github repo

```text theme={"system"}
USAGE
  $ sqd init NAME [--interactive] [-t <value>] [-d <value>] [-r]

ARGUMENTS
  NAME  The squid name. It must contain only alphanumeric or dash ("-") symbols and must not start with "-".

FLAGS
  -d, --dir=<value>
      The target location for the squid. If omitted, a new folder NAME is created.

  -r, --remove
      Clean up the target directory if it exists

  -t, --template=<value>
      A template for the squid. Accepts:
      - a github repository URL containing a valid squid.yaml manifest in the root folder
      or one of the pre-defined aliases:
      - 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.

  --[no-]interactive
      Disable interactive mode
```

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

For example, initialize the current EVM template without prompts:

```bash theme={"system"}
sqd init my-squid --template evm --no-interactive
```

*See code: [src/commands/init.ts](https://github.com/subsquid/squid-cli/blob/master/src/commands/init.ts)*


## Related topics

- [Quickstart](/en/sdk/pipes-sdk/evm/quickstart.md)
- [Railway deployment](/en/sdk/pipes-sdk/evm/guides/advanced-topics/railway-deployment.md)
- [Use with Ganache or Hardhat](/en/sdk/squid-sdk/evm/examples-tutorials/use-with-ganache-hardhat.md)
- [Build an Indexer from Scratch](/en/sdk/squid-sdk/evm/examples-tutorials/build-indexer-from-scratch.md)
- [Deploy Command](/en/cloud/reference/cli/deploy.md)


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