Skip to content

docs: correct readme claims about sync, settings, storage, and paths - #12

Merged
aikins01 merged 1 commit into
mainfrom
docs/readme-match-code
Oct 31, 2026
Merged

aikins01 merged 1 commit into
mainfrom
docs/readme-match-code

Conversation

@aikins01

Copy link
Copy Markdown
Contributor

A few README statements didn't match the code:

  • The Settings field is labeled Extra roots, not Extra directories, and the agent status list shows only agents with data (ok or error) and tokscale agents still waiting for files (sync required).
  • Not every log that grew is read from where the last sync stopped. Most JSONL logs are, but Claude Code logs, JSON files, SQLite databases, and the Cursor CSV are read again in full when they change.
  • Priced costs aren't marked "estimated" anywhere in the dashboard; that value only shows up as estimatedCostUsd in --json.
  • The list of stored data left out the cost source, the deduplication ID, read errors, and the sync history, and the file hash is a hash of sampled content.
  • The data folder also holds the SQLite -wal and -shm files.
  • The Cursor file pattern is usage.csv and usage.*.csv, and MiniMax Code falls back to XDG_CONFIG_HOME like the other tokscale caches.

The overview screenshot predates the Share stats button but otherwise matches the current dashboard, so it stays as is.

@aikins01 aikins01 self-assigned this Oct 31, 2026
@aikins01
aikins01 merged commit 3ea9864 into main Oct 31, 2026
2 checks passed
@aikins01
aikins01 deleted the docs/readme-match-code branch October 31, 2026 17:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant