tanstack add
Add add-ons to an existing project.
Add-on Compile
Run tanstack add-on compile after metadata or template changes.
Add-on contract
Add-ons declare files, packages, environment variables, options, hooks, dependencies, and conflicts.
Add-on Dev
tanstack add-on dev auto-refreshes .add-on and add-on.json on file changes.
Add-ons: Auth, Database, Deployment, Monitoring
Add-ons for auth, databases, deployment, monitoring and more.
Add to existing project
Add add-ons to an existing project.
Show add-on details
Show details for a specific add-on: dependencies, options, conflicts.
App-level MCP add-on
The app-level mcp add-on remains available for projects hosting their own MCP endpoints.
Building a Full Stack DevJokes App with TanStack Start
Catalog inspector
Inspect TanStack libraries, add-ons, and ecosystem entries from the terminal.
CLI Introspection
Discover add-ons, docs, libraries, and ecosystem data directly from CLI.
Composition model
A template owns the baseline; add-ons layer focused capabilities on top, staying inspectable.
Create a Template
Create a project with the desired shape, initialize template metadata, edit template-info.json, compile output JSON.
tanstack create
Create a new TanStack application, by default a TanStack Start app with SSR.
create command
npx @tanstack/cli create acme-app --add-ons drizzle generates a project plan and files.
Create a Project
Interactive prompts guide you through project name, package manager, and add-on selection.
Create with specific add-ons
Create a project with specific add-ons selected.
Creating Add-ons
Build and maintain your own add-on outside the built-in catalog; add-ons add files, dependencies, and code hooks to generated projects.
Create custom add-ons
Author your own add-ons.
Demo Routes
Add-on demo routes are added under src/routes/demo.
EJS Templates
Files ending in .ejs are processed with variables like projectName, typescript, tailwind, addOnEnabled, addOnOption.
Environment Variables
Some add-ons require API keys; projects may include .env.example.
tanstack doc
Fetch a TanStack documentation page by library and path.
Hooks (Integrations)
Inject code into generated projects via root-provider, provider, vite-plugin, devtools, header-user, and layout hooks.
Install uuid for generating unique IDs
--intent
Include local skill mappings for coding agents.
Interactive mode to pick add-ons
Interactively choose add-ons during project creation.
List all available add-ons
Command to list all available add-ons.
tanstack libraries
List TanStack libraries with optional group filtering.
Maintain a Template
When the source project changes, publish the updated template.json to the URL your team uses.
tanstack add-on
Create and manage custom add-ons with init and compile.
tanstack template
Create reusable project templates with init and compile.
MCP Migration
Move MCP-based workflows to CLI commands.
MCP server removed
The CLI MCP server is removed and will not be restored.
Nice to know
Non-Interactive
Pass -y to skip selection prompts; a non-empty target also requires --force.
tanstack pin-versions
Pin TanStack package versions to avoid conflicts.
Prerequisites
Registry Format
Registry entries can expose templates under templates or starters.
Reusable Project Templates
Reusable project templates.
Router-only SPA (no SSR)
Scaffold a router-only single-page app without SSR.
Run the Project
Starts the project at http://localhost:3000.
Scaffold TanStack Start & Router Applications
Scaffold TanStack Start & Router applications.
tanstack search-docs
Search TanStack documentation.
Setting up a TanStack Start Project
Step 1.1: Create a JSON File with Jokes
Step 1.2: Create Types for Our Data
Step 1.3: Create Server Functions to Read the File
Step 1.4: Consume Server Function on the Client Side
Step 1: Reading Data From a File
tanstack add
Add add-ons to an existing project.
tanstack add-on
Create and manage custom add-ons with init and compile.
tanstack create
Create a new TanStack application, by default a TanStack Start app with SSR.
tanstack doc
Fetch a TanStack documentation page by library and path.
tanstack libraries
List TanStack libraries with optional group filtering.
tanstack pin-versions
Pin TanStack package versions to avoid conflicts.
tanstack search-docs
Search TanStack documentation.
TanStack Start app (default, with SSR)
Scaffold a TanStack Start app with server-side rendering by default.
tanstack template
Create reusable project templates.
Templates
A template owns the starting application, package manager, file layout, and default conventions.
Understanding the project structure
Use a Template
--template accepts both URL/path values and built-in template IDs.
What You'll Learn