Repository navigation
docs: rewrite the readme with agent data paths and privacy details - #11
Merged
Merged
Conversation
The README said nothing leaves the machine, but the tool downloads the models.dev price catalog. It now names that request and states that usage data stays local, warns that the dashboard has no authentication when bound beyond localhost, and lists where each agent's data is read from, with environment overrides.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README said "Nothing leaves your machine", but the tool downloads the public models.dev price catalog, at most once an hour. It now says usage data stays on the machine and names that request as the only outbound one.
It also adds what a new user needs to run and trust the tool. The Node.js 22 requirement and the
telemetry-statscommand name for a global install are now stated, along with the short CLI flags. A warning says the dashboard and its API have no authentication, so--host 0.0.0.0exposes usage data and the settings and sync endpoints to the network. The README now explains how syncing works and what Settings controls, what is stored and where, withTELEMETRY_STATS_DATA_DIRand how to reset, and the share card. The agent list is now a collapsed table of where each agent's data is read from, with its environment overrides, and says that Cursor, Antigravity, Trae, Warp / Oz, and MiniMax Code need tokscale's caches.Images use raw.githubusercontent.com URLs, like the existing screenshot, so they also render on the npm page.
The Amp adapter reads
~/.local/share/amp/threads, which current Amp versions may no longer write. The README describes what the code reads; whether Amp support still works needs a separate check.