mirror of
https://github.com/rtk-ai/rtk.git
synced 2026-09-19 07:33:17 +08:00
Florian BRUNIAUX
6e55f8984c
Structure: - Move docs/README.md → .github/docs-pipeline-contract.md (interface contract is not user-facing content) - Rewrite docs/guide/index.md as a proper landing page with RTK intro, flow diagram, and navigation (replaces empty nav stub) - Move configuration.md → getting-started/configuration.md (sidebar order 4, after supported-agents per Adrien's suggestion) Missing content: - Add docs/guide/analytics/discover.md: rtk discover (missed savings analysis) and rtk session (adoption tracking across sessions) - Add uninstall instructions to installation.md (rtk init -g --uninstall, cargo uninstall, brew uninstall) - Add global flags section to what-rtk-covers.md (-u/--ultra-compact, -v/--verbose) - Add rtk smart command to what-rtk-covers.md Files section Agents: - Update supported-agents.md: 10 agents (was 9) - Add OpenClaw (TypeScript plugin, before_tool_call) - Add Mistral Vibe (planned, issue #800) - Fix GitHub Copilot: VS Code = transparent rewrite via PreToolUse, Copilot CLI = deny-with-suggestion (upstream limitation) Signed-off-by: Florian BRUNIAUX <florian@bruniaux.com>
1.8 KiB
1.8 KiB
title, description, sidebar
| title | description | sidebar | ||
|---|---|---|---|---|
| Installation | Install RTK via curl, Homebrew, Cargo, or from source, and verify the correct version |
|
Installation
Name collision warning
Two unrelated projects share the name rtk. Make sure you install the right one:
- Rust Token Killer (
rtk-ai/rtk) — this project, a token-saving CLI proxy - Rust Type Kit (
reachingforthejack/rtk) — a different tool for generating Rust types
The easiest way to verify you have the correct one: run rtk gain. It should display token savings stats. If it returns "command not found", you either have the wrong package or RTK is not installed.
Check before installing
rtk --version # should print: rtk x.y.z
rtk gain # should show token savings stats
If both commands work, RTK is already installed. Skip to Project initialization.
Quick install (Linux and macOS)
curl -fsSL https://raw.githubusercontent.com/rtk-ai/rtk/master/install.sh | sh
Homebrew (macOS and Linux)
brew install rtk-ai/tap/rtk
Cargo
cargo install rtk
Verify installation
rtk --version # rtk x.y.z
rtk gain # token savings dashboard
If rtk gain fails but rtk --version succeeds, you installed Rust Type Kit by mistake. Uninstall it first:
cargo uninstall rtk
Then reinstall using one of the methods above.
Project initialization
Run once per project to enable the Claude Code hook:
rtk init
For a global install that patches settings.json automatically:
rtk init --global
Uninstall
rtk init -g --uninstall # remove hook, RTK.md, and settings.json entry
cargo uninstall rtk # remove binary (if installed via Cargo)
brew uninstall rtk # remove binary (if installed via Homebrew)