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

index.md

121 lines4.5 KB

TanStack CLI

Quick Reference

# Create TanStack Start app
npx @tanstack/cli create my-app

# With add-ons
npx @tanstack/cli create my-app --add-ons clerk,drizzle,tanstack-query

# Add to existing project
npx @tanstack/cli add clerk drizzle

# List available add-ons
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    # Setup
pnpm dev                       # Watch mode

# Test from peer directory (not inside monorepo)
node ../cli/packages/cli/dist/index.js create my-app

Key Terminology

TermDefinitionCLI Flag
Add-onPlugin that extends apps (auth, DB, etc)--add-ons
StarterReusable preset of add-ons (config only)--starter
FrameworkReact or Solid--framework

CLI Commands

CommandDescription
tanstack create [name]Create TanStack Start app
tanstack add [add-ons]Add to existing project
tanstack add-on init/compileCreate custom add-on
tanstack starter init/compileCreate custom starter
tanstack mcp [--sse]Start MCP server
tanstack pin-versionsPin TanStack packages

Create Options

FlagDescription
--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-gitSkip git init
--no-installSkip npm install
-yAccept defaults
-f, --forceOverwrite existing
--uiLaunch visual builder

EJS Template Variables

VariableTypeDescription
projectNamestringProject name
typescriptbooleanAlways true (TanStack Start requires TS)
tailwindbooleanAlways true (Tailwind always enabled)
fileRouterbooleanAlways true
addOnEnabledobject{ [id]: boolean }
addOnOptionobject{ [id]: options }
packageManagerstringnpm/pnpm/yarn/bun/deno
jsstringAlways ts
jsxstringAlways tsx

Testing Add-ons Locally

# Serve add-on
npx serve .add-on -l 9080

# Use in create
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

FilePurpose
packages/cli/src/cli.tsCLI command definitions
packages/create/src/frameworks/Framework implementations
packages/create/src/app-*.tsApp creation logic
.tanstack.jsonGenerated project config