Files

T

History

Adrien Eppling a1673f7428 docs: scope savings claims to bash output and document the estimator

RTK was documented as delivering "60-90% token savings", which reads as a
cost reduction. What RTK actually reduces is bash output bytes. Those are
one contributor to input tokens, which are themselves only part of a bill
that also counts output tokens, so the reduction dilutes at every step.

- add docs/guide/resources/savings-explained.md as the canonical explainer:
  the savings chain, both estimators, and what RTK does not reduce
- rescope the headline claim across README (7 languages), the guide, hook
  rules, agent definitions and module READMEs
- relabel per-command tables as bash output reduction, keeping every figure
- document that reported tokens are estimates: rtk gain uses bytes/4
  (src/core/tracking.rs), filter tests use split_whitespace().count().
  Neither is a real tokenizer, so ratios hold but absolute counts do not

Remove figures that had no source: the $3/Mtok constant and its $36
example, the +/-10% tokenization accuracy claim, the 99.5% hook-install
figure, the invented session tables in README and INSTALL, and the 30-50%
parser range.

CHANGELOG is untouched. Shipped release notes stay as a historical record.

2026-07-22 18:33:54 +02:00

README.md

chore(refacto-codebase): Folders + Technical docs

2026-03-24 22:14:35 +01:00

rules.md

docs: scope savings claims to bash output and document the estimator

2026-07-22 18:33:54 +02:00

README.md

Windsurf (Cascade) Hooks

Part of hooks/ — see also src/hooks/ for installation code

Specifics

Prompt-level guidance only (no programmatic hook) -- relies on Windsurf Cascade reading rules files
rules.md contains the instruction to prefix commands with rtk
Installed to .windsurfrules (project-local, workspace-scoped) by rtk init