Skip to content
Source
Sign inSign up
TanStack/cli
Open History to see the last commit

quick-start.md

60 lines1.1 KB

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# With add-ons
21npx @tanstack/cli create my-app --add-ons tanstack-query,clerk,drizzle
22​
23# Router-only SPA (no SSR)
24npx @tanstack/cli create my-app --router-only
25```
26​
27## Run the Project
28​
29```bash
30cd my-app
31pnpm dev
32# Open http://localhost:3000
33```
34​
35## Environment Variables
36​
37Some add-ons require API keys. After creation:
38​
39```bash
40cp .env.example .env
41# Edit .env with your values
42```
43​
44## Project Structure
45​
46```
47my-app/
48├── src/
49│ ├── routes/ # File-based routing
50│ │ ├── __root.tsx # Root layout
51│ │ └── index.tsx # Home page
52│ └── integrations/ # Add-on integration code
53├── .tanstack.json # CLI config
54└── .env.example # Required env vars
55```
56​
57## Next Steps
58​
59- [CLI Reference](./cli-reference.md) - All options
60- [Add-ons](./add-ons.md) - Available add-ons