feat(cli): allow disable telemetry

This commit is contained in:
Aman Varshney
2025-07-13 18:56:57 +05:30
parent 864e863656
commit 65c29c26c5
6 changed files with 71 additions and 5 deletions

View File

@@ -66,6 +66,32 @@ Options:
-h, --help Display help
```
## Telemetry
This CLI collects anonymous usage data to help improve the tool. The data collected includes:
- Configuration options selected
- CLI version
- Node.js version
- Platform (OS)
**Telemetry is enabled by default in published versions** to help us understand usage patterns and improve the tool.
### Disabling Telemetry
You can disable telemetry by setting the `BTS_TELEMETRY` environment variable:
```bash
# Disable telemetry for a single run
BTS_TELEMETRY=0 npx create-better-t-stack my-app
# Disable telemetry globally in your shell profile (.bashrc, .zshrc, etc.)
export BTS_TELEMETRY=0
```
### Development
During development, telemetry is automatically disabled when `NODE_ENV=development`.
## Examples
Create a project with default configuration: