Florian BRUNIAUX
4c9b528206
Hierarchy: - Move troubleshooting.md and what-rtk-covers.md to guide/resources/ - Add guide/resources/telemetry.md (adapted from docs/TELEMETRY.md, user-facing: consent, opt-out, GDPR rights — without internal sections) Content fixes: - Remove all hardcoded counts (9 ecosystems, 12 agents, 60+, 7 more) replaced with qualitative language throughout - Unify DB filename: tracking.db → history.db everywhere (canonical: src/core/constants.rs HISTORY_DB) - installation.md: replace bare `cargo install rtk` with warning + explicit git URL to avoid Rust Type Kit name collision - supported-agents.md: remove hardcoded agent count - quick-start.md: remove hardcoded ecosystem list, link to what-rtk-covers New content: - gain.md: add --quota section explaining pro/5x/20x tier meanings - gain.md: add callout linking to discover.md (find missed savings) - index.md: add "Analyze your usage" section (rtk discover, rtk session) - configuration.md: clarify ignore_dirs/ignore_files scope, add prose link to telemetry.md - what-rtk-covers.md: clarify --ultra-compact vs git -u short flag conflict Cross-references: - All internal links updated for new resources/ paths - index.md: link to troubleshooting, telemetry, what-rtk-covers, analytics - discover.md: updated relative link to troubleshooting README: - Add Core team section (Patrick Szymkowiak, Florian Bruniaux, Adrien Eppling) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1.9 KiB
title, description, sidebar
| title | description | sidebar | ||
|---|---|---|---|---|
| Quick Start | Get RTK running in 5 minutes and see your first token savings |
|
Quick Start
This guide walks you through your first RTK commands after installation.
Prerequisites
RTK is installed and verified:
rtk --version # rtk x.y.z
rtk gain # shows token savings dashboard
If not, see Installation.
Step 1: Initialize for your AI assistant
# For Claude Code (global — applies to all projects)
rtk init --global
# For a single project only
cd /your/project && rtk init
This installs the hook that automatically rewrites commands. Restart your AI assistant after this step.
Step 2: Use your tools normally
Once the hook is installed, nothing changes in how you work. Your AI assistant runs commands as usual — the hook intercepts them transparently and rewrites them before execution.
For example, when Claude Code runs cargo test, the hook rewrites it to rtk cargo test before it executes. The LLM receives filtered output with only the failures — not 500 lines of passing tests. You never see or type rtk.
RTK covers all major ecosystems — Git, Cargo/Rust, JavaScript, Python, Go, Ruby, .NET, Docker/Kubernetes, and more. See What RTK Optimizes for the full list.
Step 3: Check your savings
After a few commands, see how much was saved:
rtk gain
Total commands : 12
Input tokens : 45,230
Output tokens : 4,890
Saved : 40,340 (89.2%)
Step 4: Unsupported commands
Commands RTK doesn't recognize run through passthrough — output is unchanged, usage is tracked:
rtk proxy make install
Next steps
- What RTK Optimizes — all supported commands and savings by ecosystem
- Supported agents — Claude Code, Cursor, Copilot, and more
- Configuration — customize RTK behavior