Getting Started

Quick Start

Create a Project

sh
npx @tanstack/cli create my-app

Interactive prompts guide you through project name, package manager, and integration selection.

Non-Interactive

sh
# Defaults only
npx @tanstack/cli create my-app -y

# With integrations
npx @tanstack/cli create my-app --integrations tanstack-query,clerk,drizzle

Run the Project

sh
cd my-app
pnpm dev
# Open http://localhost:3000

Environment Variables

Some integrations require API keys. After creation:

sh
cp .env.example .env
# Edit .env with your values

Project Structure

my-app/
├── src/
│   ├── routes/          # File-based routing
│   │   ├── __root.tsx   # Root layout
│   │   └── index.tsx    # Home page
│   └── integrations/    # Integration code
├── .tanstack.json       # CLI config
└── .env.example         # Required env vars

Next Steps