truecourse 0.2.1 → 0.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +33 -0
  2. package/cli.mjs +1361 -968
  3. package/package.json +4 -2
  4. package/server.mjs +41029 -32184
package/README.md CHANGED
@@ -178,6 +178,39 @@ All rules are visible in the **Rules** tab in the web UI. Custom rule generation
178
178
  | Rust | Planned |
179
179
  | PHP | Planned |
180
180
 
181
+ ## Telemetry
182
+
183
+ TrueCourse collects anonymous usage data to help us understand adoption and improve the product. Telemetry is **enabled by default** and can be disabled at any time.
184
+
185
+ ### What is collected
186
+
187
+ - Event type (`analyze` or `diff-check`)
188
+ - Tool version
189
+ - Languages detected (e.g., TypeScript, Python)
190
+ - File count range (bucketed: 1-50, 50-200, etc.)
191
+ - Service count
192
+ - Analysis duration range (bucketed)
193
+ - OS and architecture (e.g., `darwin-arm64`)
194
+ - Random anonymous session ID (not tied to user identity)
195
+
196
+ ### What is NOT collected
197
+
198
+ - Source code, file paths, repo names, or git URLs
199
+ - Violation details, rule results, or LLM outputs
200
+ - IP addresses, user identity, or machine hostname
201
+
202
+ ### Opt out
203
+
204
+ ```bash
205
+ npx truecourse telemetry disable # Disable telemetry
206
+ npx truecourse telemetry enable # Re-enable telemetry
207
+ npx truecourse telemetry status # Check current status
208
+ ```
209
+
210
+ Telemetry is automatically disabled in CI environments (`CI=true`) and can also be disabled by setting `TRUECOURSE_TELEMETRY=0`.
211
+
212
+ Data is sent to [PostHog](https://posthog.com) for aggregation.
213
+
181
214
  ## License
182
215
 
183
216
  MIT