Skip to content

fix: add telemetry documentation and init notice (#640)#788

Merged
pszymkowiak merged 1 commit intodevelopfrom
fix/telemetry-docs
Mar 23, 2026
Merged

fix: add telemetry documentation and init notice (#640)#788
pszymkowiak merged 1 commit intodevelopfrom
fix/telemetry-docs

Conversation

@pszymkowiak
Copy link
Copy Markdown
Collaborator

Addresses H-1 from #640 (security review).

Changes

  • README.md: Add "Privacy & Telemetry" section explaining what is collected, what is NOT, and how to opt-out
  • src/init.rs: Show telemetry notice during rtk init so users are informed at install time

What RTK collects (anonymous, daily, opt-out)

  • Device hash (SHA-256, not reversible)
  • Version, OS, arch
  • Command count + top command names (no arguments, no file paths)
  • Token savings %

What RTK does NOT collect

Source code, file paths, command arguments, secrets, environment variables, PII.

Opt-out

RTK_TELEMETRY_DISABLED=1 or [telemetry] enabled = false in config.toml.

- 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>
@pszymkowiak pszymkowiak added documentation Improvements or additions to documentation effort-small Quelques heures, 1 fichier labels Mar 23, 2026
@pszymkowiak
Copy link
Copy Markdown
Collaborator Author

[w] wshm · Automated triage by AI

📊 Automated PR Analysis

📝 Type docs
🟢 Risk low

Summary

Adds a Privacy & Telemetry section to the README documenting what data RTK collects and how to opt out, and displays a one-time telemetry notice during rtk init. This addresses a security review finding (H-1) from issue #640.

Review Checklist

  • Tests present
  • Breaking change
  • Docs updated

Linked issues: #640


Analyzed automatically by wshm · This is an automated analysis, not a human review.

@pszymkowiak pszymkowiak merged commit 0eecee5 into develop Mar 23, 2026
9 checks passed
romualdbassinot-efficy pushed a commit to romualdbassinot-efficy/rtk that referenced this pull request Mar 29, 2026
…#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>
romualdbassinot-efficy pushed a commit to romualdbassinot-efficy/rtk that referenced this pull request Apr 10, 2026
…#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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation effort-small Quelques heures, 1 fichier

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant