@hasna/terminal 2.3.0 → 2.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (267) hide show
  1. package/dist/App.js +404 -0
  2. package/dist/Browse.js +79 -0
  3. package/dist/FuzzyPicker.js +47 -0
  4. package/dist/Onboarding.js +51 -0
  5. package/dist/Spinner.js +12 -0
  6. package/dist/StatusBar.js +49 -0
  7. package/dist/ai.js +322 -0
  8. package/dist/cache.js +41 -0
  9. package/dist/cli.js +64 -16
  10. package/dist/command-rewriter.js +64 -0
  11. package/dist/command-validator.js +86 -0
  12. package/dist/compression.js +107 -0
  13. package/dist/context-hints.js +275 -0
  14. package/dist/diff-cache.js +107 -0
  15. package/dist/discover.js +212 -0
  16. package/dist/economy.js +123 -0
  17. package/dist/expand-store.js +38 -0
  18. package/dist/file-cache.js +72 -0
  19. package/dist/file-index.js +62 -0
  20. package/dist/history.js +62 -0
  21. package/dist/lazy-executor.js +54 -0
  22. package/dist/line-dedup.js +59 -0
  23. package/dist/loop-detector.js +75 -0
  24. package/dist/mcp/install.js +98 -0
  25. package/dist/mcp/server.js +569 -0
  26. package/dist/noise-filter.js +86 -0
  27. package/dist/output-processor.js +129 -0
  28. package/dist/output-router.js +41 -0
  29. package/dist/output-store.js +111 -0
  30. package/dist/parsers/base.js +2 -0
  31. package/dist/parsers/build.js +64 -0
  32. package/dist/parsers/errors.js +101 -0
  33. package/dist/parsers/files.js +78 -0
  34. package/dist/parsers/git.js +99 -0
  35. package/dist/parsers/index.js +48 -0
  36. package/dist/parsers/tests.js +89 -0
  37. package/dist/providers/anthropic.js +39 -0
  38. package/dist/providers/base.js +4 -0
  39. package/dist/providers/cerebras.js +95 -0
  40. package/dist/providers/groq.js +95 -0
  41. package/dist/providers/index.js +73 -0
  42. package/dist/providers/xai.js +95 -0
  43. package/dist/recipes/model.js +20 -0
  44. package/dist/recipes/storage.js +136 -0
  45. package/dist/search/content-search.js +68 -0
  46. package/dist/search/file-search.js +61 -0
  47. package/dist/search/filters.js +34 -0
  48. package/dist/search/index.js +5 -0
  49. package/dist/search/semantic.js +320 -0
  50. package/dist/session-boot.js +59 -0
  51. package/dist/session-context.js +55 -0
  52. package/dist/sessions-db.js +173 -0
  53. package/dist/smart-display.js +286 -0
  54. package/dist/snapshots.js +51 -0
  55. package/dist/supervisor.js +112 -0
  56. package/dist/test-watchlist.js +131 -0
  57. package/dist/tool-profiles.js +122 -0
  58. package/dist/tree.js +94 -0
  59. package/dist/usage-cache.js +65 -0
  60. package/package.json +8 -1
  61. package/src/ai.ts +8 -0
  62. package/src/cli.tsx +57 -18
  63. package/src/output-processor.ts +6 -1
  64. package/src/output-store.ts +58 -12
  65. package/src/tool-profiles.ts +139 -0
  66. package/.claude/scheduled_tasks.lock +0 -1
  67. package/.github/ISSUE_TEMPLATE/bug_report.md +0 -20
  68. package/.github/ISSUE_TEMPLATE/feature_request.md +0 -14
  69. package/CONTRIBUTING.md +0 -80
  70. package/benchmarks/benchmark.mjs +0 -115
  71. package/imported_modules.txt +0 -0
  72. package/temp/rtk/.claude/agents/code-reviewer.md +0 -221
  73. package/temp/rtk/.claude/agents/debugger.md +0 -519
  74. package/temp/rtk/.claude/agents/rtk-testing-specialist.md +0 -461
  75. package/temp/rtk/.claude/agents/rust-rtk.md +0 -511
  76. package/temp/rtk/.claude/agents/technical-writer.md +0 -355
  77. package/temp/rtk/.claude/commands/diagnose.md +0 -352
  78. package/temp/rtk/.claude/commands/test-routing.md +0 -362
  79. package/temp/rtk/.claude/hooks/bash/pre-commit-format.sh +0 -16
  80. package/temp/rtk/.claude/hooks/rtk-rewrite.sh +0 -70
  81. package/temp/rtk/.claude/hooks/rtk-suggest.sh +0 -152
  82. package/temp/rtk/.claude/rules/cli-testing.md +0 -526
  83. package/temp/rtk/.claude/skills/issue-triage/SKILL.md +0 -348
  84. package/temp/rtk/.claude/skills/issue-triage/templates/issue-comment.md +0 -134
  85. package/temp/rtk/.claude/skills/performance.md +0 -435
  86. package/temp/rtk/.claude/skills/pr-triage/SKILL.md +0 -315
  87. package/temp/rtk/.claude/skills/pr-triage/templates/review-comment.md +0 -71
  88. package/temp/rtk/.claude/skills/repo-recap.md +0 -206
  89. package/temp/rtk/.claude/skills/rtk-tdd/SKILL.md +0 -78
  90. package/temp/rtk/.claude/skills/rtk-tdd/references/testing-patterns.md +0 -124
  91. package/temp/rtk/.claude/skills/security-guardian.md +0 -503
  92. package/temp/rtk/.claude/skills/ship.md +0 -404
  93. package/temp/rtk/.github/workflows/benchmark.yml +0 -34
  94. package/temp/rtk/.github/workflows/dco-check.yaml +0 -12
  95. package/temp/rtk/.github/workflows/release-please.yml +0 -51
  96. package/temp/rtk/.github/workflows/release.yml +0 -343
  97. package/temp/rtk/.github/workflows/security-check.yml +0 -135
  98. package/temp/rtk/.github/workflows/validate-docs.yml +0 -78
  99. package/temp/rtk/.release-please-manifest.json +0 -3
  100. package/temp/rtk/ARCHITECTURE.md +0 -1491
  101. package/temp/rtk/CHANGELOG.md +0 -640
  102. package/temp/rtk/CLAUDE.md +0 -605
  103. package/temp/rtk/CONTRIBUTING.md +0 -199
  104. package/temp/rtk/Cargo.lock +0 -1668
  105. package/temp/rtk/Cargo.toml +0 -64
  106. package/temp/rtk/Formula/rtk.rb +0 -43
  107. package/temp/rtk/INSTALL.md +0 -390
  108. package/temp/rtk/LICENSE +0 -21
  109. package/temp/rtk/README.md +0 -386
  110. package/temp/rtk/README_es.md +0 -159
  111. package/temp/rtk/README_fr.md +0 -197
  112. package/temp/rtk/README_ja.md +0 -159
  113. package/temp/rtk/README_ko.md +0 -159
  114. package/temp/rtk/README_zh.md +0 -167
  115. package/temp/rtk/ROADMAP.md +0 -15
  116. package/temp/rtk/SECURITY.md +0 -217
  117. package/temp/rtk/TEST_EXEC_TIME.md +0 -102
  118. package/temp/rtk/build.rs +0 -57
  119. package/temp/rtk/docs/AUDIT_GUIDE.md +0 -432
  120. package/temp/rtk/docs/FEATURES.md +0 -1410
  121. package/temp/rtk/docs/TROUBLESHOOTING.md +0 -309
  122. package/temp/rtk/docs/filter-workflow.md +0 -102
  123. package/temp/rtk/docs/images/gain-dashboard.jpg +0 -0
  124. package/temp/rtk/docs/tracking.md +0 -583
  125. package/temp/rtk/hooks/opencode-rtk.ts +0 -39
  126. package/temp/rtk/hooks/rtk-awareness.md +0 -29
  127. package/temp/rtk/hooks/rtk-rewrite.sh +0 -61
  128. package/temp/rtk/hooks/test-rtk-rewrite.sh +0 -442
  129. package/temp/rtk/install.sh +0 -124
  130. package/temp/rtk/release-please-config.json +0 -10
  131. package/temp/rtk/scripts/benchmark.sh +0 -592
  132. package/temp/rtk/scripts/check-installation.sh +0 -162
  133. package/temp/rtk/scripts/install-local.sh +0 -37
  134. package/temp/rtk/scripts/rtk-economics.sh +0 -137
  135. package/temp/rtk/scripts/test-all.sh +0 -561
  136. package/temp/rtk/scripts/test-aristote.sh +0 -227
  137. package/temp/rtk/scripts/test-tracking.sh +0 -79
  138. package/temp/rtk/scripts/update-readme-metrics.sh +0 -32
  139. package/temp/rtk/scripts/validate-docs.sh +0 -73
  140. package/temp/rtk/src/aws_cmd.rs +0 -880
  141. package/temp/rtk/src/binlog.rs +0 -1645
  142. package/temp/rtk/src/cargo_cmd.rs +0 -1727
  143. package/temp/rtk/src/cc_economics.rs +0 -1157
  144. package/temp/rtk/src/ccusage.rs +0 -340
  145. package/temp/rtk/src/config.rs +0 -187
  146. package/temp/rtk/src/container.rs +0 -855
  147. package/temp/rtk/src/curl_cmd.rs +0 -134
  148. package/temp/rtk/src/deps.rs +0 -268
  149. package/temp/rtk/src/diff_cmd.rs +0 -367
  150. package/temp/rtk/src/discover/mod.rs +0 -274
  151. package/temp/rtk/src/discover/provider.rs +0 -388
  152. package/temp/rtk/src/discover/registry.rs +0 -2022
  153. package/temp/rtk/src/discover/report.rs +0 -202
  154. package/temp/rtk/src/discover/rules.rs +0 -667
  155. package/temp/rtk/src/display_helpers.rs +0 -402
  156. package/temp/rtk/src/dotnet_cmd.rs +0 -1771
  157. package/temp/rtk/src/dotnet_format_report.rs +0 -133
  158. package/temp/rtk/src/dotnet_trx.rs +0 -593
  159. package/temp/rtk/src/env_cmd.rs +0 -204
  160. package/temp/rtk/src/filter.rs +0 -462
  161. package/temp/rtk/src/filters/README.md +0 -52
  162. package/temp/rtk/src/filters/ansible-playbook.toml +0 -34
  163. package/temp/rtk/src/filters/basedpyright.toml +0 -47
  164. package/temp/rtk/src/filters/biome.toml +0 -45
  165. package/temp/rtk/src/filters/brew-install.toml +0 -37
  166. package/temp/rtk/src/filters/composer-install.toml +0 -40
  167. package/temp/rtk/src/filters/df.toml +0 -16
  168. package/temp/rtk/src/filters/dotnet-build.toml +0 -64
  169. package/temp/rtk/src/filters/du.toml +0 -16
  170. package/temp/rtk/src/filters/fail2ban-client.toml +0 -15
  171. package/temp/rtk/src/filters/gcc.toml +0 -49
  172. package/temp/rtk/src/filters/gcloud.toml +0 -22
  173. package/temp/rtk/src/filters/hadolint.toml +0 -24
  174. package/temp/rtk/src/filters/helm.toml +0 -29
  175. package/temp/rtk/src/filters/iptables.toml +0 -27
  176. package/temp/rtk/src/filters/jj.toml +0 -28
  177. package/temp/rtk/src/filters/jq.toml +0 -24
  178. package/temp/rtk/src/filters/make.toml +0 -41
  179. package/temp/rtk/src/filters/markdownlint.toml +0 -24
  180. package/temp/rtk/src/filters/mix-compile.toml +0 -27
  181. package/temp/rtk/src/filters/mix-format.toml +0 -15
  182. package/temp/rtk/src/filters/mvn-build.toml +0 -44
  183. package/temp/rtk/src/filters/oxlint.toml +0 -43
  184. package/temp/rtk/src/filters/ping.toml +0 -63
  185. package/temp/rtk/src/filters/pio-run.toml +0 -40
  186. package/temp/rtk/src/filters/poetry-install.toml +0 -50
  187. package/temp/rtk/src/filters/pre-commit.toml +0 -35
  188. package/temp/rtk/src/filters/ps.toml +0 -16
  189. package/temp/rtk/src/filters/quarto-render.toml +0 -41
  190. package/temp/rtk/src/filters/rsync.toml +0 -48
  191. package/temp/rtk/src/filters/shellcheck.toml +0 -27
  192. package/temp/rtk/src/filters/shopify-theme.toml +0 -29
  193. package/temp/rtk/src/filters/skopeo.toml +0 -45
  194. package/temp/rtk/src/filters/sops.toml +0 -16
  195. package/temp/rtk/src/filters/ssh.toml +0 -44
  196. package/temp/rtk/src/filters/stat.toml +0 -34
  197. package/temp/rtk/src/filters/swift-build.toml +0 -41
  198. package/temp/rtk/src/filters/systemctl-status.toml +0 -33
  199. package/temp/rtk/src/filters/terraform-plan.toml +0 -35
  200. package/temp/rtk/src/filters/tofu-fmt.toml +0 -16
  201. package/temp/rtk/src/filters/tofu-init.toml +0 -38
  202. package/temp/rtk/src/filters/tofu-plan.toml +0 -35
  203. package/temp/rtk/src/filters/tofu-validate.toml +0 -17
  204. package/temp/rtk/src/filters/trunk-build.toml +0 -39
  205. package/temp/rtk/src/filters/ty.toml +0 -50
  206. package/temp/rtk/src/filters/uv-sync.toml +0 -37
  207. package/temp/rtk/src/filters/xcodebuild.toml +0 -99
  208. package/temp/rtk/src/filters/yamllint.toml +0 -25
  209. package/temp/rtk/src/find_cmd.rs +0 -598
  210. package/temp/rtk/src/format_cmd.rs +0 -386
  211. package/temp/rtk/src/gain.rs +0 -723
  212. package/temp/rtk/src/gh_cmd.rs +0 -1651
  213. package/temp/rtk/src/git.rs +0 -2012
  214. package/temp/rtk/src/go_cmd.rs +0 -592
  215. package/temp/rtk/src/golangci_cmd.rs +0 -254
  216. package/temp/rtk/src/grep_cmd.rs +0 -288
  217. package/temp/rtk/src/gt_cmd.rs +0 -810
  218. package/temp/rtk/src/hook_audit_cmd.rs +0 -283
  219. package/temp/rtk/src/hook_check.rs +0 -171
  220. package/temp/rtk/src/init.rs +0 -1859
  221. package/temp/rtk/src/integrity.rs +0 -537
  222. package/temp/rtk/src/json_cmd.rs +0 -231
  223. package/temp/rtk/src/learn/detector.rs +0 -628
  224. package/temp/rtk/src/learn/mod.rs +0 -119
  225. package/temp/rtk/src/learn/report.rs +0 -184
  226. package/temp/rtk/src/lint_cmd.rs +0 -694
  227. package/temp/rtk/src/local_llm.rs +0 -316
  228. package/temp/rtk/src/log_cmd.rs +0 -248
  229. package/temp/rtk/src/ls.rs +0 -324
  230. package/temp/rtk/src/main.rs +0 -2482
  231. package/temp/rtk/src/mypy_cmd.rs +0 -389
  232. package/temp/rtk/src/next_cmd.rs +0 -241
  233. package/temp/rtk/src/npm_cmd.rs +0 -236
  234. package/temp/rtk/src/parser/README.md +0 -267
  235. package/temp/rtk/src/parser/error.rs +0 -46
  236. package/temp/rtk/src/parser/formatter.rs +0 -336
  237. package/temp/rtk/src/parser/mod.rs +0 -311
  238. package/temp/rtk/src/parser/types.rs +0 -119
  239. package/temp/rtk/src/pip_cmd.rs +0 -302
  240. package/temp/rtk/src/playwright_cmd.rs +0 -479
  241. package/temp/rtk/src/pnpm_cmd.rs +0 -573
  242. package/temp/rtk/src/prettier_cmd.rs +0 -221
  243. package/temp/rtk/src/prisma_cmd.rs +0 -482
  244. package/temp/rtk/src/psql_cmd.rs +0 -382
  245. package/temp/rtk/src/pytest_cmd.rs +0 -384
  246. package/temp/rtk/src/read.rs +0 -217
  247. package/temp/rtk/src/rewrite_cmd.rs +0 -50
  248. package/temp/rtk/src/ruff_cmd.rs +0 -402
  249. package/temp/rtk/src/runner.rs +0 -271
  250. package/temp/rtk/src/summary.rs +0 -297
  251. package/temp/rtk/src/tee.rs +0 -405
  252. package/temp/rtk/src/telemetry.rs +0 -248
  253. package/temp/rtk/src/toml_filter.rs +0 -1655
  254. package/temp/rtk/src/tracking.rs +0 -1416
  255. package/temp/rtk/src/tree.rs +0 -209
  256. package/temp/rtk/src/tsc_cmd.rs +0 -259
  257. package/temp/rtk/src/utils.rs +0 -432
  258. package/temp/rtk/src/verify_cmd.rs +0 -47
  259. package/temp/rtk/src/vitest_cmd.rs +0 -385
  260. package/temp/rtk/src/wc_cmd.rs +0 -401
  261. package/temp/rtk/src/wget_cmd.rs +0 -260
  262. package/temp/rtk/tests/fixtures/dotnet/build_failed.txt +0 -11
  263. package/temp/rtk/tests/fixtures/dotnet/format_changes.json +0 -31
  264. package/temp/rtk/tests/fixtures/dotnet/format_empty.json +0 -1
  265. package/temp/rtk/tests/fixtures/dotnet/format_success.json +0 -12
  266. package/temp/rtk/tests/fixtures/dotnet/test_failed.txt +0 -18
  267. package/tsconfig.json +0 -15
@@ -1,64 +0,0 @@
1
- [package]
2
- name = "rtk"
3
- version = "0.29.0"
4
- edition = "2021"
5
- authors = ["Patrick Szymkowiak"]
6
- description = "Rust Token Killer - High-performance CLI proxy to minimize LLM token consumption"
7
- license = "MIT"
8
- homepage = "https://www.rtk-ai.app"
9
- repository = "https://github.com/rtk-ai/rtk"
10
- readme = "README.md"
11
- keywords = ["cli", "llm", "token", "filter", "productivity"]
12
- categories = ["command-line-utilities", "development-tools"]
13
-
14
- [dependencies]
15
- clap = { version = "4", features = ["derive"] }
16
- anyhow = "1.0"
17
- ignore = "0.4"
18
- walkdir = "2"
19
- regex = "1"
20
- lazy_static = "1.4"
21
- serde = { version = "1", features = ["derive"] }
22
- serde_json = { version = "1", features = ["preserve_order"] }
23
- colored = "2"
24
- dirs = "5"
25
- rusqlite = { version = "0.31", features = ["bundled"] }
26
- toml = "0.8"
27
- chrono = "0.4"
28
- thiserror = "1.0"
29
- tempfile = "3"
30
- sha2 = "0.10"
31
- ureq = "2"
32
- hostname = "0.4"
33
- flate2 = "1.0"
34
- quick-xml = "0.37"
35
-
36
- [build-dependencies]
37
- toml = "0.8"
38
-
39
- [dev-dependencies]
40
-
41
- [profile.release]
42
- opt-level = 3
43
- lto = true
44
- codegen-units = 1
45
- panic = "abort"
46
- strip = true
47
-
48
- # cargo-deb configuration
49
- [package.metadata.deb]
50
- maintainer = "Patrick Szymkowiak"
51
- copyright = "2024 Patrick Szymkowiak"
52
- license-file = ["LICENSE", "0"]
53
- extended-description = "rtk filters and compresses command outputs before they reach your LLM context, saving 60-90% of tokens."
54
- section = "utility"
55
- priority = "optional"
56
- assets = [
57
- ["target/release/rtk", "usr/bin/", "755"],
58
- ]
59
-
60
- # cargo-generate-rpm configuration
61
- [package.metadata.generate-rpm]
62
- assets = [
63
- { source = "target/release/rtk", dest = "/usr/bin/rtk", mode = "755" },
64
- ]
@@ -1,43 +0,0 @@
1
- # typed: false
2
- # frozen_string_literal: true
3
-
4
- # Homebrew formula for rtk - Rust Token Killer
5
- # To install: brew tap rtk-ai/tap && brew install rtk
6
- class Rtk < Formula
7
- desc "High-performance CLI proxy to minimize LLM token consumption"
8
- homepage "https://www.rtk-ai.app"
9
- version "0.1.0"
10
- license "MIT"
11
-
12
- on_macos do
13
- on_intel do
14
- url "https://github.com/rtk-ai/rtk/releases/download/v#{version}/rtk-x86_64-apple-darwin.tar.gz"
15
- sha256 "PLACEHOLDER_SHA256_INTEL"
16
- end
17
-
18
- on_arm do
19
- url "https://github.com/rtk-ai/rtk/releases/download/v#{version}/rtk-aarch64-apple-darwin.tar.gz"
20
- sha256 "PLACEHOLDER_SHA256_ARM"
21
- end
22
- end
23
-
24
- on_linux do
25
- on_intel do
26
- url "https://github.com/rtk-ai/rtk/releases/download/v#{version}/rtk-x86_64-unknown-linux-gnu.tar.gz"
27
- sha256 "PLACEHOLDER_SHA256_LINUX_INTEL"
28
- end
29
-
30
- on_arm do
31
- url "https://github.com/rtk-ai/rtk/releases/download/v#{version}/rtk-aarch64-unknown-linux-gnu.tar.gz"
32
- sha256 "PLACEHOLDER_SHA256_LINUX_ARM"
33
- end
34
- end
35
-
36
- def install
37
- bin.install "rtk"
38
- end
39
-
40
- test do
41
- assert_match "rtk #{version}", shell_output("#{bin}/rtk --version")
42
- end
43
- end
@@ -1,390 +0,0 @@
1
- # RTK Installation Guide - For AI Coding Assistants
2
-
3
- ## ⚠️ Name Collision Warning
4
-
5
- **There are TWO completely different projects named "rtk":**
6
-
7
- 1. ✅ **Rust Token Killer** (this project) - LLM token optimizer
8
- - Repos: `rtk-ai/rtk`
9
- - Has `rtk gain` command for token savings stats
10
-
11
- 2. ❌ **Rust Type Kit** (reachingforthejack/rtk) - DIFFERENT PROJECT
12
- - Rust codebase query tool and type generator
13
- - **DO NOT install if you want token optimization**
14
-
15
- ## Pre-Installation Check (REQUIRED)
16
-
17
- **AI assistants should ALWAYS verify if RTK is already installed before attempting installation.**
18
-
19
- ```bash
20
- # Check if RTK is installed
21
- rtk --version
22
-
23
- # CRITICAL: Verify it's the Token Killer (not Type Kit)
24
- rtk gain # Should show token savings stats, NOT "command not found"
25
-
26
- # Check installation path
27
- which rtk
28
- ```
29
-
30
- If `rtk gain` works, you have the **correct** RTK installed. **DO NOT reinstall**. Skip to "Project Initialization".
31
-
32
- If `rtk gain` fails but `rtk --version` succeeds, you have the **wrong** RTK (Type Kit). Uninstall and reinstall the correct one (see below).
33
-
34
- ## Installation (only if RTK not available or wrong RTK installed)
35
-
36
- ### Step 0: Uninstall Wrong RTK (if needed)
37
-
38
- If you accidentally installed Rust Type Kit:
39
-
40
- ```bash
41
- cargo uninstall rtk
42
- ```
43
-
44
- ### Quick Install (Linux/macOS)
45
-
46
- ```bash
47
- curl -fsSL https://raw.githubusercontent.com/rtk-ai/rtk/master/install.sh | sh
48
- ```
49
-
50
- After installation, **verify you have the correct rtk**:
51
- ```bash
52
- rtk gain # Must show token savings stats (not "command not found")
53
- ```
54
-
55
- ### Alternative: Manual Installation
56
-
57
- ```bash
58
- # From rtk-ai repository (NOT reachingforthejack!)
59
- cargo install --git https://github.com/rtk-ai/rtk
60
-
61
- # OR (if published and correct on crates.io)
62
- cargo install rtk
63
-
64
- # ALWAYS VERIFY after installation
65
- rtk gain # MUST show token savings, not "command not found"
66
- ```
67
-
68
- ⚠️ **WARNING**: `cargo install rtk` from crates.io might install the wrong package. Always verify with `rtk gain`.
69
-
70
- ## Project Initialization
71
-
72
- ### Which mode to choose?
73
-
74
- ```
75
- Do you want RTK active across ALL Claude Code projects?
76
-
77
- ├─ YES → rtk init -g (recommended)
78
- │ Hook + RTK.md (~10 tokens in context)
79
- │ Commands auto-rewritten transparently
80
-
81
- ├─ YES, minimal → rtk init -g --hook-only
82
- │ Hook only, nothing added to CLAUDE.md
83
- │ Zero tokens in context
84
-
85
- └─ NO, single project → rtk init
86
- Local CLAUDE.md only (137 lines)
87
- No hook, no global effect
88
- ```
89
-
90
- ### Recommended: Global Hook-First Setup
91
-
92
- **Best for: All projects, automatic RTK usage**
93
-
94
- ```bash
95
- rtk init -g
96
- # → Installs hook to ~/.claude/hooks/rtk-rewrite.sh
97
- # → Creates ~/.claude/RTK.md (10 lines, meta commands only)
98
- # → Adds @RTK.md reference to ~/.claude/CLAUDE.md
99
- # → Prompts: "Patch settings.json? [y/N]"
100
- # → If yes: patches + creates backup (~/.claude/settings.json.bak)
101
-
102
- # Automated alternatives:
103
- rtk init -g --auto-patch # Patch without prompting
104
- rtk init -g --no-patch # Print manual instructions instead
105
-
106
- # Verify installation
107
- rtk init --show # Check hook is installed and executable
108
- ```
109
-
110
- **Token savings**: ~99.5% reduction (2000 tokens → 10 tokens in context)
111
-
112
- **What is settings.json?**
113
- Claude Code's hook registry. RTK adds a PreToolUse hook that rewrites commands transparently. Without this, Claude won't invoke the hook automatically.
114
-
115
- ```
116
- Claude Code settings.json rtk-rewrite.sh RTK binary
117
- │ │ │ │
118
- │ "git status" │ │ │
119
- │ ──────────────────►│ │ │
120
- │ │ PreToolUse trigger │ │
121
- │ │ ───────────────────►│ │
122
- │ │ │ rewrite command │
123
- │ │ │ → rtk git status │
124
- │ │◄────────────────────│ │
125
- │ │ updated command │ │
126
- │ │ │
127
- │ execute: rtk git status │
128
- │ ─────────────────────────────────────────────────────────────►│
129
- │ │ filter
130
- │ "3 modified, 1 untracked ✓" │
131
- │◄──────────────────────────────────────────────────────────────│
132
- ```
133
-
134
- **Backup Safety**:
135
- RTK backs up existing settings.json before changes. Restore if needed:
136
- ```bash
137
- cp ~/.claude/settings.json.bak ~/.claude/settings.json
138
- ```
139
-
140
- ### Alternative: Local Project Setup
141
-
142
- **Best for: Single project without hook**
143
-
144
- ```bash
145
- cd /path/to/your/project
146
- rtk init # Creates ./CLAUDE.md with full RTK instructions (137 lines)
147
- ```
148
-
149
- **Token savings**: Instructions loaded only for this project
150
-
151
- ### Upgrading from Previous Version
152
-
153
- #### From old 137-line CLAUDE.md injection (pre-0.22)
154
-
155
- ```bash
156
- rtk init -g # Automatically migrates to hook-first mode
157
- # → Removes old 137-line block
158
- # → Installs hook + RTK.md
159
- # → Adds @RTK.md reference
160
- ```
161
-
162
- #### From old hook with inline logic (pre-0.24) — ⚠️ Breaking Change
163
-
164
- RTK 0.24.0 replaced the inline command-detection hook (~200 lines) with a **thin delegator** that calls `rtk rewrite`. The binary now contains the rewrite logic, so adding new commands no longer requires a hook update.
165
-
166
- The old hook still works but won't benefit from new rules added in future releases.
167
-
168
- ```bash
169
- # Upgrade hook to thin delegator
170
- rtk init --global
171
-
172
- # Verify the new hook is active
173
- rtk init --show
174
- # Should show: ✅ Hook: ... (thin delegator, up to date)
175
- ```
176
-
177
- ## Common User Flows
178
-
179
- ### First-Time User (Recommended)
180
- ```bash
181
- # 1. Install RTK
182
- cargo install --git https://github.com/rtk-ai/rtk
183
- rtk gain # Verify (must show token stats)
184
-
185
- # 2. Setup with prompts
186
- rtk init -g
187
- # → Answer 'y' when prompted to patch settings.json
188
- # → Creates backup automatically
189
-
190
- # 3. Restart Claude Code
191
- # 4. Test: git status (should use rtk)
192
- ```
193
-
194
- ### CI/CD or Automation
195
- ```bash
196
- # Non-interactive setup (no prompts)
197
- rtk init -g --auto-patch
198
-
199
- # Verify in scripts
200
- rtk init --show | grep "Hook:"
201
- ```
202
-
203
- ### Conservative User (Manual Control)
204
- ```bash
205
- # Get manual instructions without patching
206
- rtk init -g --no-patch
207
-
208
- # Review printed JSON snippet
209
- # Manually edit ~/.claude/settings.json
210
- # Restart Claude Code
211
- ```
212
-
213
- ### Temporary Trial
214
- ```bash
215
- # Install hook
216
- rtk init -g --auto-patch
217
-
218
- # Later: remove everything
219
- rtk init -g --uninstall
220
-
221
- # Restore backup if needed
222
- cp ~/.claude/settings.json.bak ~/.claude/settings.json
223
- ```
224
-
225
- ## Installation Verification
226
-
227
- ```bash
228
- # Basic test
229
- rtk ls .
230
-
231
- # Test with git
232
- rtk git status
233
-
234
- # Test with pnpm (fork only)
235
- rtk pnpm list
236
-
237
- # Test with Vitest (feat/vitest-support branch only)
238
- rtk vitest run
239
- ```
240
-
241
- ## Uninstalling
242
-
243
- ### Complete Removal (Global Installations Only)
244
-
245
- ```bash
246
- # Complete removal (global installations only)
247
- rtk init -g --uninstall
248
-
249
- # What gets removed:
250
- # - Hook: ~/.claude/hooks/rtk-rewrite.sh
251
- # - Context: ~/.claude/RTK.md
252
- # - Reference: @RTK.md line from ~/.claude/CLAUDE.md
253
- # - Registration: RTK hook entry from settings.json
254
-
255
- # Restart Claude Code after uninstall
256
- ```
257
-
258
- **For Local Projects**: Manually remove RTK block from `./CLAUDE.md`
259
-
260
- ### Binary Removal
261
-
262
- ```bash
263
- # If installed via cargo
264
- cargo uninstall rtk
265
-
266
- # If installed via package manager
267
- brew uninstall rtk # macOS Homebrew
268
- sudo apt remove rtk # Debian/Ubuntu
269
- sudo dnf remove rtk # Fedora/RHEL
270
- ```
271
-
272
- ### Restore from Backup (if needed)
273
-
274
- ```bash
275
- cp ~/.claude/settings.json.bak ~/.claude/settings.json
276
- ```
277
-
278
- ## Essential Commands
279
-
280
- ### Files
281
- ```bash
282
- rtk ls . # Compact tree view
283
- rtk read file.rs # Optimized reading
284
- rtk grep "pattern" . # Grouped search results
285
- ```
286
-
287
- ### Git
288
- ```bash
289
- rtk git status # Compact status
290
- rtk git log -n 10 # Condensed logs
291
- rtk git diff # Optimized diff
292
- rtk git add . # → "ok ✓"
293
- rtk git commit -m "msg" # → "ok ✓ abc1234"
294
- rtk git push # → "ok ✓ main"
295
- ```
296
-
297
- ### Pnpm (fork only)
298
- ```bash
299
- rtk pnpm list # Dependency tree (-70% tokens)
300
- rtk pnpm outdated # Available updates (-80-90%)
301
- rtk pnpm install pkg # Silent installation
302
- ```
303
-
304
- ### Tests
305
- ```bash
306
- rtk test cargo test # Failures only (-90%)
307
- rtk vitest run # Filtered Vitest output (-99.6%)
308
- ```
309
-
310
- ### Statistics
311
- ```bash
312
- rtk gain # Token savings
313
- rtk gain --graph # With ASCII graph
314
- rtk gain --history # With command history
315
- ```
316
-
317
- ## Validated Token Savings
318
-
319
- ### Production T3 Stack Project
320
- | Operation | Standard | RTK | Reduction |
321
- |-----------|----------|-----|-----------|
322
- | `vitest run` | 102,199 chars | 377 chars | **-99.6%** |
323
- | `git status` | 529 chars | 217 chars | **-59%** |
324
- | `pnpm list` | ~8,000 tokens | ~2,400 | **-70%** |
325
- | `pnpm outdated` | ~12,000 tokens | ~1,200-2,400 | **-80-90%** |
326
-
327
- ### Typical Claude Code Session (30 min)
328
- - **Without RTK**: ~150,000 tokens
329
- - **With RTK**: ~45,000 tokens
330
- - **Savings**: **70% reduction**
331
-
332
- ## Troubleshooting
333
-
334
- ### RTK command not found after installation
335
- ```bash
336
- # Check PATH
337
- echo $PATH | grep -o '[^:]*\.cargo[^:]*'
338
-
339
- # Add to PATH if needed (~/.bashrc or ~/.zshrc)
340
- export PATH="$HOME/.cargo/bin:$PATH"
341
-
342
- # Reload shell
343
- source ~/.bashrc # or source ~/.zshrc
344
- ```
345
-
346
- ### RTK command not available (e.g., vitest)
347
- ```bash
348
- # Check branch
349
- cd /path/to/rtk
350
- git branch
351
-
352
- # Switch to feat/vitest-support if needed
353
- git checkout feat/vitest-support
354
-
355
- # Reinstall
356
- cargo install --path . --force
357
- ```
358
-
359
- ### Compilation error
360
- ```bash
361
- # Update Rust
362
- rustup update stable
363
-
364
- # Clean and recompile
365
- cargo clean
366
- cargo build --release
367
- cargo install --path . --force
368
- ```
369
-
370
- ## Support and Contributing
371
-
372
- - **Website**: https://www.rtk-ai.app
373
- - **Contact**: contact@rtk-ai.app
374
- - **Troubleshooting**: See [TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md) for common issues
375
- - **GitHub issues**: https://github.com/rtk-ai/rtk/issues
376
- - **Pull Requests**: https://github.com/rtk-ai/rtk/pulls
377
-
378
- ⚠️ **If you installed the wrong rtk (Type Kit)**, see [TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md#problem-rtk-gain-command-not-found)
379
-
380
- ## AI Assistant Checklist
381
-
382
- Before each session:
383
-
384
- - [ ] Verify RTK is installed: `rtk --version`
385
- - [ ] If not installed → follow "Install from fork"
386
- - [ ] If project not initialized → `rtk init`
387
- - [ ] Use `rtk` for ALL git/pnpm/test/vitest commands
388
- - [ ] Check savings: `rtk gain`
389
-
390
- **Golden Rule**: AI coding assistants should ALWAYS use `rtk` as a proxy for shell commands that generate verbose output (git, pnpm, npm, cargo test, vitest, docker, kubectl).
package/temp/rtk/LICENSE DELETED
@@ -1,21 +0,0 @@
1
- MIT License
2
-
3
- Copyright (c) 2024 Patrick Szymkowiak
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.