TanStack CLI#
Quick Reference#
npx @tanstack/cli create my-app
npx @tanstack/cli create my-app --add-ons clerk,drizzle,tanstack-query
npx @tanstack/cli add clerk drizzle
npx @tanstack/cli create --list-add-ons
Monorepo Structure#
cli/
├── packages/
│ ├── cli/ # @tanstack/cli - Main CLI
│ ├── create/ # @tanstack/create - Core engine + frameworks
│ │ └── src/frameworks/
│ │ ├── react/ # React framework + add-ons
│ │ └── solid/ # Solid framework + add-ons
│ └── create-ui/ # @tanstack/create-ui - Web UI
└── cli-aliases/ # Deprecated wrappers (create-tsrouter-app, etc.)
Development#
pnpm install && pnpm build
pnpm dev
node ../cli/packages/cli/dist/index.js create my-app
Key Terminology#
| Term | Definition | CLI Flag |
|---|
| Add-on | Plugin that extends apps (auth, DB, etc) | --add-ons |
| Starter | Reusable preset of add-ons (config only) | --starter |
| Framework | React or Solid | --framework |
CLI Commands#
| Command | Description |
|---|
tanstack create [name] | Create TanStack Start app |
tanstack add [add-ons] | Add to existing project |
tanstack add-on init/compile | Create custom add-on |
tanstack starter init/compile | Create custom starter |
tanstack mcp [--sse] | Start MCP server |
tanstack pin-versions | Pin TanStack packages |
Create Options#
| Flag | Description |
|---|
--add-ons <ids> | Comma-separated add-on IDs |
--framework <name> | React or Solid |
--toolchain <id> | Toolchain (use --list-add-ons to see options) |
--deployment <id> | Deployment target (use --list-add-ons to see options) |
--starter <url> | Use starter preset |
--no-git | Skip git init |
--no-install | Skip npm install |
-y | Accept defaults |
-f, --force | Overwrite existing |
--ui | Launch visual builder |
EJS Template Variables#
| Variable | Type | Description |
|---|
projectName | string | Project name |
typescript | boolean | Always true (TanStack Start requires TS) |
tailwind | boolean | Always true (Tailwind always enabled) |
fileRouter | boolean | Always true |
addOnEnabled | object | { [id]: boolean } |
addOnOption | object | { [id]: options } |
packageManager | string | npm/pnpm/yarn/bun/deno |
js | string | Always ts |
jsx | string | Always tsx |
Testing Add-ons Locally#
npx serve .add-on -l 9080
node packages/cli/dist/index.js create test --add-ons http://localhost:9080/info.json
MCP Server Config#
{
"mcpServers": {
"tanstack": {
"command": "npx",
"args": ["@tanstack/cli", "mcp"]
}
}
}
Key Files#
| File | Purpose |
|---|
packages/cli/src/cli.ts | CLI command definitions |
packages/create/src/frameworks/ | Framework implementations |
packages/create/src/app-*.ts | App creation logic |
.tanstack.json | Generated project config |