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

cli-reference.md

229 lines5.0 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| `--template <url-or-id>` | Template URL/path or built-in template ID |
18| `--package-manager <pm>` | `npm`, `pnpm`, `yarn`, `bun`, `deno` |
19| `--framework <name>` | `React`, `Solid` |
20| `--router-only` | Create file-based Router-only app without TanStack Start (add-ons/deployment/template disabled) |
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| `--examples` / `--no-examples` | Include or exclude demo/example pages |
24| `--tailwind` / `--no-tailwind` | Deprecated compatibility flags; accepted but ignored (Tailwind is always enabled) |
25| `--no-git` | Skip git init |
26| `--no-install` | Skip dependency install |
27| `-y, --yes` | Use defaults, skip prompts |
28| `--interactive` | Force interactive mode |
29| `--target-dir <path>` | Custom output directory |
30| `-f, --force` | Overwrite existing directory |
31| `--list-add-ons` | List all available add-ons |
32| `--addon-details <id>` | Show details for specific add-on |
33| `--json` | Output machine-readable JSON for automation |
34| `--add-on-config <json>` | JSON string with add-on options |
35​
36```bash
37# Examples
38tanstack create my-app -y
39tanstack create my-app --add-ons clerk,drizzle,tanstack-query
40tanstack create my-app --router-only --toolchain eslint --no-examples
41tanstack create my-app --template https://example.com/template.json
42tanstack create my-app --template ecommerce
43tanstack create --list-add-ons --framework React --json
44tanstack create --addon-details drizzle --framework React --json
45```
46​
47---
48​
49## tanstack add
50​
51Add add-ons to an existing project.
52​
53```bash
54tanstack add [add-on...] [options]
55```
56​
57| Option | Description |
58|--------|-------------|
59| `--forced` | Force add-on installation even if conflicts exist |
60​
61```bash
62# Examples
63tanstack add clerk drizzle
64tanstack add tanstack-query,tanstack-form
65```
66​
67Visual setup is available at `https://tanstack.com/builder`.
68​
69---
70​
71## tanstack add-on
72​
73Create and manage custom add-ons.
74​
75### init
76​
77Extract add-on from current project:
78​
79```bash
80tanstack add-on init
81```
82​
83Creates `.add-on/` folder with `info.json` and `assets/`.
84​
85### compile
86​
87Rebuild after changes:
88​
89```bash
90tanstack add-on compile
91```
92​
93See [Creating Add-ons](./creating-add-ons.md) for full guide.
94​
95---
96​
97## tanstack template
98​
99Create reusable project templates.
100​
101### init
102​
103```bash
104tanstack template init
105```
106​
107Creates `template-info.json` and `template.json`.
108​
109### compile
110​
111```bash
112tanstack template compile
113```
114​
115See [Templates](./templates.md) for full guide.
116​
117## tanstack libraries
118​
119List TanStack libraries with optional group filtering.
120​
121```bash
122tanstack libraries [options]
123```
124​
125| Option | Description |
126|--------|-------------|
127| `--group <group>` | Filter by group: `state`, `headlessUI`, `performance`, `tooling` |
128| `--json` | Output machine-readable JSON |
129​
130```bash
131tanstack libraries
132tanstack libraries --group state --json
133```
134​
135---
136​
137## tanstack doc
138​
139Fetch a TanStack documentation page by library and path.
140​
141```bash
142tanstack doc <library> <path> [options]
143```
144​
145| Option | Description |
146|--------|-------------|
147| `--docs-version <version>` | Docs version (default: `latest`) |
148| `--json` | Output machine-readable JSON |
149​
150```bash
151tanstack doc router framework/react/guide/data-loading
152tanstack doc query framework/react/overview --docs-version v5 --json
153```
154​
155---
156​
157## tanstack search-docs
158​
159Search TanStack documentation.
160​
161```bash
162tanstack search-docs <query> [options]
163```
164​
165| Option | Description |
166|--------|-------------|
167| `--library <id>` | Filter by library ID |
168| `--framework <name>` | Filter by framework |
169| `--limit <n>` | Max results (default `10`, max `50`) |
170| `--json` | Output machine-readable JSON |
171​
172```bash
173tanstack search-docs "server functions" --library start
174tanstack search-docs loaders --library router --framework react --json
175```
176​
177---
178​
179## tanstack ecosystem
180​
181List ecosystem partner recommendations.
182​
183```bash
184tanstack ecosystem [options]
185```
186​
187| Option | Description |
188|--------|-------------|
189| `--category <category>` | Filter by category |
190| `--library <id>` | Filter by TanStack library |
191| `--json` | Output machine-readable JSON |
192​
193```bash
194tanstack ecosystem --category database
195tanstack ecosystem --library router --json
196```
197​
198---
199​
200## tanstack pin-versions
201​
202Pin TanStack package versions to avoid conflicts.
203​
204```bash
205tanstack pin-versions
206```
207​
208Removes `^` from version ranges for TanStack packages and adds any missing peer dependencies.
209​
210---
211​
212## Configuration
213​
214Projects include `.tanstack.json`:
215​
216```json
218 "version": 1,
219 "projectName": "my-app",
220 "framework": "react",
221 "mode": "file-router",
222 "typescript": true,
223 "tailwind": true,
224 "packageManager": "pnpm",
225 "chosenAddOns": ["tanstack-query", "clerk"]
227```
228​
229Used by `add-on init` and `template init` to detect changes.