Skip to content

Commit 4176bf3

Browse files
committed
feat(cli): add anonymous telemetry and opt-out controls
1 parent 4cd8184 commit 4176bf3

File tree

7 files changed

+1641
-482
lines changed

7 files changed

+1641
-482
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@tanstack/cli': minor
3+
---
4+
5+
Add anonymous CLI telemetry with PostHog-backed command and step tracking, plus first-run disclosure and opt-out controls via config, env vars, and `tanstack telemetry` commands.

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,22 @@ npx @tanstack/cli search-docs "loaders" --library router --framework react --jso
6363
- [TanStack Start](https://tanstack.com/start)
6464
- [TanStack Router](https://tanstack.com/router)
6565

66+
## Telemetry
67+
68+
TanStack 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+
74+
Manage it with:
75+
76+
```bash
77+
tanstack telemetry status
78+
tanstack telemetry disable
79+
tanstack telemetry enable
80+
```
81+
6682
## Get Involved
6783

6884
- [GitHub Issues](https://github.com/TanStack/cli/issues)

0 commit comments

Comments
 (0)