Open History to see the last commit
1---
2id: quick-start
3title: Quick Start
4---
5
6## Create a Project
7
8```bash
9npx @tanstack/cli create my-app
10```
11
12Interactive prompts guide you through project name, package manager, and add-on selection.
13
14## Non-Interactive
15
16```bash
17# Defaults only (TanStack Start + file-router)
18npx @tanstack/cli create my-app -y
19
20# Minimal one-route Start project
21npx @tanstack/cli create my-app --blank -y
22
23# Minimal Start project configured for Cloudflare
24npx @tanstack/cli create my-app --blank --deployment cloudflare -y
25
26# With add-ons
27npx @tanstack/cli create my-app --add-ons tanstack-query,clerk,drizzle -y
28
29# Router-only SPA (no SSR)
30npx @tanstack/cli create my-app --router-only -y
31
32# Rsbuild instead of the default Vite build tool
33npx @tanstack/cli create my-app --build-tool rsbuild -y
34
35# Minimal router-only Rsbuild app
36npx @tanstack/cli create my-app --build-tool rsbuild --router-only --blank -y
37```
38
39Blank projects omit the default starter interface, examples, Tailwind,
40devtools, test stack, and TanStack Intent setup. Pass `--intent` to include
41local skill mappings for coding agents. Explicit add-ons can add their own
42required files and dependencies. Pass `-y` to skip selection prompts. A
43non-empty target also requires `--force`.
44
45## Run the Project
46
47```bash
48cd my-app
49pnpm dev
50# Open http://localhost:3000
51```
52
53## Environment Variables
54
55Some add-ons require API keys. When the project includes `.env.example`:
56
57```bash
58cp .env.example .env
59# Edit .env with your values
60```
61
62## Project Structure
63
64```
65my-app/
66├── src/
67│ ├── routes/ # File-based routing
68│ │ ├── __root.tsx # Root layout
69│ │ └── index.tsx # Home page
70│ └── integrations/ # Present when selected add-ons need it
71├── .cta.json # CLI config
72└── .env.example # Present when selected add-ons need env vars
73```
74
75## Next Steps
76
77- [CLI Reference](./cli-reference.md) - All options
78- [Add-ons](./add-ons.md) - Available add-ons