TanStack CLI

What is TanStack CLI about?

TanStack CLI enables rapid project scaffolding, add‑on installation, and library discovery for the TanStack ecosystem. It streamlines the setup of TanStack Start applications, router‑only SPAs, and integrates popular services such as Clerk, Drizzle, and TanStack Query.

How to use TanStack CLI?

# Create a new TanStack Start app (default SSR)
npx @tanstack/cli create my-app

# Create a router‑only SPA (no SSR)
npx @tanstack/cli create my-app --router-only

# Create an app with specific add‑ons
npx @tanstack/cli create my-app --add-ons clerk,drizzle,tanstack-query

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

# List available add‑ons
npx @tanstack/cli create --list-add-ons

# Agent‑friendly JSON introspection
npx @tanstack/cli create --addon-details tanstack-query --json
npx @tanstack/cli libraries --json
npx @tanstack/cli search-docs "loaders" --library router --framework react --json

Key Features of TanStack CLI

• TanStack Start: Full‑stack SSR framework (default scaffold).
• TanStack Router: Type‑safe routing with an option for SPA‑only scaffolding.
• Add‑ons: One‑click installation of authentication, database, deployment, monitoring, etc.
• CLI Introspection: JSON output for machine‑readable discovery, ideal for agents.
• Library Search: Query documentation across TanStack libraries via CLI.
• Extensible: Supports custom add‑ons and future ecosystem growth.

Use Cases of TanStack CLI

• Bootstrapping new full‑stack applications with minimal configuration.
• Quickly converting an existing project to use TanStack Router or Start.
• Adding authentication, ORM, or analytics add‑ons without manual setup.
• Integrating with AI agents or automation scripts that consume JSON CLI output.
• Performing library documentation searches programmatically during development.

FAQ from the TanStack CLI

Q: Do I need to install the CLI globally? A: No. Use npx @tanstack/cli for one‑off commands; the package will be fetched automatically.

Q: Can I scaffold a project without SSR? A: Yes. Use the --router-only flag to generate a SPA version.

Q: How do I discover which add‑ons are available? A: Run npx @tanstack/cli create --list-add-ons or consult the documentation.

Q: Is there a way to get machine‑readable output? A: Append --json to supported commands for JSON‑formatted results.

Q: Where can I report issues or contribute? A: Use the GitHub repository’s Issues, Discussions, and the CONTRIBUTING guide.

Become a Sponsor!

TanStack CLI

Create and manage TanStack Router and Start applications.

npx @tanstack/cli create my-app

Features

• TanStack Start - Full-stack SSR framework (default)
• TanStack Router - Type-safe routing (--router-only for SPA)
• Add-ons - Auth, database, deployment, monitoring, and more
• CLI Introspection - Agent-friendly discovery via JSON CLI output

Quick Start

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

# Create Router-only SPA (no SSR)
npx @tanstack/cli create my-app --router-only

# 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

# Agent-friendly introspection
npx @tanstack/cli create --addon-details tanstack-query --json
npx @tanstack/cli libraries --json
npx @tanstack/cli search-docs "loaders" --library router --framework react --json

Documentation

• CLI Reference
• TanStack Start
• TanStack Router

Get Involved

• GitHub Issues
• GitHub Discussions
• Discord
• Contributing Guide

TanStack Ecosystem

• TanStack Query - Async state & caching
• TanStack Router - Type-safe routing
• TanStack Start - Full-stack SSR
• TanStack Form - Type-safe forms
• TanStack Table - Headless datagrids
• TanStack Store - Reactive state
• TanStack Virtual - Virtualized rendering

More at TanStack.com