Skip to content

Commit 0eecee5

Browse files
authored
fix: add telemetry documentation and init notice (#640) (#788)
- Add "Privacy & Telemetry" section to README explaining what is collected, what is NOT, and how to opt-out - Show telemetry notice during rtk init so users are informed Signed-off-by: Patrick szymkowiak <patrick.szymkowiak@innovtech.eu>
1 parent af56573 commit 0eecee5

2 files changed

Lines changed: 27 additions & 0 deletions

File tree

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -410,6 +410,28 @@ brew uninstall rtk # If installed via Homebrew
410410
- **[SECURITY.md](SECURITY.md)** - Security policy and PR review process
411411
- **[AUDIT_GUIDE.md](docs/AUDIT_GUIDE.md)** - Token savings analytics guide
412412

413+
## Privacy & Telemetry
414+
415+
RTK collects **anonymous, aggregate usage metrics** once per day to help prioritize development. This is standard practice for open-source CLI tools.
416+
417+
**What is collected:**
418+
- Device hash (SHA-256 of hostname+username, not reversible)
419+
- RTK version, OS, architecture
420+
- Command count (last 24h) and top command names (e.g. "git", "cargo" — no arguments, no file paths)
421+
- Token savings percentage
422+
423+
**What is NOT collected:** source code, file paths, command arguments, secrets, environment variables, or any personally identifiable information.
424+
425+
**Opt-out** (any of these):
426+
```bash
427+
# Environment variable
428+
export RTK_TELEMETRY_DISABLED=1
429+
430+
# Or in config file (~/.config/rtk/config.toml)
431+
[telemetry]
432+
enabled = false
433+
```
434+
413435
## Contributing
414436

415437
Contributions welcome! Please open an issue or PR on [GitHub](https://github.com/rtk-ai/rtk).

src/init.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -279,6 +279,11 @@ pub fn run(
279279
install_cursor_hooks(verbose)?;
280280
}
281281

282+
// Telemetry notice (shown once during init)
283+
println!();
284+
println!(" [info] Anonymous telemetry is enabled (opt-out: RTK_TELEMETRY_DISABLED=1)");
285+
println!(" [info] See: https://github.com/rtk-ai/rtk#privacy--telemetry");
286+
282287
Ok(())
283288
}
284289

0 commit comments

Comments
 (0)