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

README.md

99 lines3.1 KB

1<div align="center">
2 <h1>TanStack CLI</h1>
3</div>
4​
5<div align="center">
6<a href="https://www.npmjs.com/package/@tanstack/cli" target="_parent">
7 <img alt="" src="https://img.shields.io/npm/dm/@tanstack/cli.svg" />
8</a>
9<a href="https://github.com/TanStack/cli/stargazers" target="_parent">
10 <img alt="" src="https://img.shields.io/github/stars/TanStack/cli.svg?style=social&label=Star" />
11</a>
12<a href="https://twitter.com/tan_stack"><img src="https://img.shields.io/twitter/follow/tan_stack.svg?style=social" /></a>
13</div>
14​
15<div align="center">
16​
17### [Become a Sponsor!](https://github.com/sponsors/tannerlinsley/)
18​
19</div>
20​
21# TanStack CLI
22​
23Create and manage TanStack Router and Start applications.
24​
25```bash
26npx @tanstack/cli create my-app
27```
28​
29## Features
30​
31- **TanStack Start** - Full-stack SSR framework (default)
32- **TanStack Router** - Type-safe routing (`--router-only` for SPA)
33- **Add-ons** - Auth, database, deployment, monitoring, and more
34- **CLI Introspection** - Agent-friendly discovery via JSON CLI output
35​
36## Quick Start
37​
38```bash
39# Create TanStack Start app (recommended)
40npx @tanstack/cli create my-app
41​
42# Create Router-only SPA (no SSR)
43npx @tanstack/cli create my-app --router-only
44​
45# With add-ons
46npx @tanstack/cli create my-app --add-ons clerk,drizzle,tanstack-query
47​
48# Add to existing project
49npx @tanstack/cli add clerk drizzle
50​
51# List available add-ons
52npx @tanstack/cli create --list-add-ons
53​
54# Agent-friendly introspection
55npx @tanstack/cli create --addon-details tanstack-query --json
56npx @tanstack/cli libraries --json
57npx @tanstack/cli search-docs "loaders" --library router --framework react --json
58```
59​
60## Documentation
61​
62- [CLI Reference](https://tanstack.com/cli/latest/docs/cli-reference)
63- [TanStack Start](https://tanstack.com/start)
64- [TanStack Router](https://tanstack.com/router)
65​
66## Telemetry
67​
68TanStack CLI sends anonymous usage telemetry by default.
69​
70- Sent: command usage, durations, selected framework/package manager/add-on ids, and coarse result metadata
71- Never sent: project names, file paths, target directories, raw search queries, raw template URLs/paths, add-on config values, env vars, or raw error messages
72- Disabled automatically in `CI`, or when `DO_NOT_TRACK=1` or `TANSTACK_CLI_TELEMETRY_DISABLED=1`
73​
74Manage it with:
75​
76```bash
77tanstack telemetry status
78tanstack telemetry disable
79tanstack telemetry enable
80```
81​
82## Get Involved
83​
84- [GitHub Issues](https://github.com/TanStack/cli/issues)
85- [GitHub Discussions](https://github.com/TanStack/cli/discussions)
86- [Discord](https://discord.com/invite/WrRKjPJ)
87- [Contributing Guide](./CONTRIBUTING.md)
88​
89## TanStack Ecosystem
90​
91- [TanStack Query](https://github.com/tanstack/query) - Async state & caching
92- [TanStack Router](https://github.com/tanstack/router) - Type-safe routing
93- [TanStack Start](https://github.com/tanstack/router) - Full-stack SSR
94- [TanStack Form](https://github.com/tanstack/form) - Type-safe forms
95- [TanStack Table](https://github.com/tanstack/table) - Headless datagrids
96- [TanStack Store](https://github.com/tanstack/store) - Reactive state
97- [TanStack Virtual](https://github.com/tanstack/virtual) - Virtualized rendering
98​
99[More at TanStack.com](https://tanstack.com)