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

cli-reference.md

160 lines3.2 KB

1---
2id: cli-reference
3title: CLI Reference
4---
5​
6## tanstack create
7​
8Create a new TanStack application. By default creates a TanStack Start app with SSR.
9​
10```bash
11tanstack create [project-name] [options]
12```
13​
14| Option | Description |
15|--------|-------------|
16| `--add-ons <ids>` | Comma-separated add-on IDs |
17| `--starter <url>` | Starter URL or local path |
18| `--package-manager <pm>` | `npm`, `pnpm`, `yarn`, `bun`, `deno` |
19| `--framework <name>` | `React`, `Solid` |
20| `--router-only` | Create Router-only SPA without TanStack Start (no SSR) |
21| `--toolchain <id>` | Toolchain add-on (use `--list-add-ons` to see options) |
22| `--deployment <id>` | Deployment add-on (use `--list-add-ons` to see options) |
23| `--tailwind` / `--no-tailwind` | Include/skip Tailwind CSS |
24| `--no-git` | Skip git init |
25| `--no-install` | Skip dependency install |
26| `-y, --yes` | Use defaults, skip prompts |
27| `--interactive` | Force interactive mode |
28| `--target-dir <path>` | Custom output directory |
29| `-f, --force` | Overwrite existing directory |
30| `--list-add-ons` | List all available add-ons |
31| `--addon-details <id>` | Show details for specific add-on |
32| `--add-on-config <json>` | JSON string with add-on options |
33| `--ui` | Launch visual project builder |
34​
35```bash
36# Examples
37tanstack create my-app -y
38tanstack create my-app --add-ons clerk,drizzle,tanstack-query
39tanstack create my-app --router-only --add-ons tanstack-query
40tanstack create my-app --starter https://example.com/starter.json
41```
42​
43---
44​
45## tanstack add
46​
47Add add-ons to an existing project.
48​
49```bash
50tanstack add [add-on...] [options]
51```
52​
53| Option | Description |
54|--------|-------------|
55| `--forced` | Force add-on installation even if conflicts exist |
56| `--ui` | Launch visual add-on picker |
57​
58```bash
59# Examples
60tanstack add clerk drizzle
61tanstack add tanstack-query,tanstack-form
62tanstack add --ui
63```
64​
65---
66​
67## tanstack add-on
68​
69Create and manage custom add-ons.
70​
71### init
72​
73Extract add-on from current project:
74​
75```bash
76tanstack add-on init
77```
78​
79Creates `.add-on/` folder with `info.json` and `assets/`.
80​
81### compile
82​
83Rebuild after changes:
84​
85```bash
86tanstack add-on compile
87```
88​
89See [Creating Add-ons](./creating-add-ons.md) for full guide.
90​
91---
92​
93## tanstack starter
94​
95Create reusable project presets.
96​
97### init
98​
99```bash
100tanstack starter init
101```
102​
103Creates `starter-info.json` and `starter.json`.
104​
105### compile
106​
107```bash
108tanstack starter compile
109```
110​
111See [Starters](./starters.md) for full guide.
112​
113---
114​
115## tanstack mcp
116​
117Start MCP server for AI agents.
118​
119```bash
120tanstack mcp [options]
121```
122​
123| Option | Description |
124|--------|-------------|
125| `--sse` | HTTP/SSE mode (default: stdio) |
126​
127See [MCP Server](./mcp/overview.md) for setup.
128​
129---
130​
131## tanstack pin-versions
132​
133Pin TanStack package versions to avoid conflicts.
134​
135```bash
136tanstack pin-versions
137```
138​
139Removes `^` from version ranges for TanStack packages and adds any missing peer dependencies.
140​
141---
142​
143## Configuration
144​
145Projects include `.tanstack.json`:
146​
147```json
149 "version": 1,
150 "projectName": "my-app",
151 "framework": "react",
152 "mode": "file-router",
153 "typescript": true,
154 "tailwind": true,
155 "packageManager": "pnpm",
156 "chosenAddOns": ["tanstack-query", "clerk"]
158```
159​
160Used by `add-on init` and `starter init` to detect changes.