Quick Start | TanStack CLI Docs

Create a Project

npx @tanstack/cli create my-app

npx @tanstack/cli create my-app

Interactive prompts guide you through project name, package manager, and add-on selection.

Non-Interactive

# Defaults only (TanStack Start + file-router)
npx @tanstack/cli create my-app -y

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

# Router-only SPA (no SSR)
npx @tanstack/cli create my-app --router-only

# Defaults only (TanStack Start + file-router)
npx @tanstack/cli create my-app -y

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

# Router-only SPA (no SSR)
npx @tanstack/cli create my-app --router-only

Run the Project

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

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

Environment Variables

Some add-ons require API keys. After creation:

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

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

Project Structure

plaintext

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

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

Next Steps

CLI Reference - All options
Add-ons - Available add-ons