@@ -129,15 +129,17 @@ leaves precise output alone:
129129| Category | Command | Through RTK? | Est. savings |
130130| ---| ---| ---| ---|
131131| Status / listings | ` rtk git status ` , ` rtk ls ` , ` rtk git log ` | 🟢 yes | ~ 80% |
132- | Logs / containers | ` rtk docker ps ` , ` rtk log app.log ` | 🟢 yes | ~ 80% |
132+ | Logs / containers | ` rtk docker ps ` , ` rtk log app.log ` * (static, not ` -f ` ) * | 🟢 yes | ~ 80% |
133133| Dependencies | ` rtk pip list ` , ` rtk pnpm list ` | 🟢 yes | ~ 70% |
134134| Tests / build | ` rtk cargo test ` , ` rtk err <cmd> ` | 🟡 plain mode (keeps failures) | ~ 90% |
135135| Diffs you'll apply | ` git diff ` , ` git show ` | 🔴 run raw | — |
136136| JSON / parsed output | ` … --format json ` | 🔴 run raw | — |
137137| Files you'll edit | native Read tool | 🔴 not RTK | — |
138138
139- _ Savings are illustrative; actual numbers vary by command and output size. Run
140- ` rtk gain ` to measure your own — and ` rtk discover ` to spot poor fits._
139+ _ Savings are illustrative and apply to ** large** output — small outputs can be
140+ net-neutral or negative. Run streaming/` -f ` commands, and anything whose pass/fail
141+ exit code matters, ** raw** (see [ Compatibility & limitations] ( #compatibility--limitations ) ).
142+ Run ` rtk gain ` to measure your own; ` rtk discover ` to spot poor fits._
141143
142144See [ references/commands.md] ( references/commands.md ) for the full tiered list and
143145[ references/analytics.md] ( references/analytics.md ) for measuring net savings.
@@ -155,6 +157,46 @@ accumulated savings. Track **net** savings, not just the headline number:
155157tee fallback keeps full output whenever a command fails. See
156158[ references/analytics.md] ( references/analytics.md ) .
157159
160+ ## Compatibility & limitations
161+
162+ This is a documentation/instruction integration: it tells Command Code * when* to
163+ route output through the real [ RTK] ( https://github.com/rtk-ai/rtk ) binary. A few
164+ things to know before relying on it:
165+
166+ - ** No native Command Code hook (yet).** RTK's ` rtk init ` supports Claude Code,
167+ Copilot, Cursor, Gemini, Cline, and others — ** not** Command Code. So
168+ ` rtk init -g ` won't wire up Command Code; the manual-prefix path this repo
169+ installs is the working default. Closing that gap upstream is the goal in
170+ [ Upstream] ( #upstream ) below.
171+ - ** Exit-code fidelity.** Agent harnesses key success off a command's exit code.
172+ RTK aims to pass it through, but this has been fixed command-by-command and
173+ isn't guaranteed for every command/version. ** For a pass/fail that matters
174+ (tests, CI gates), trust the raw exit code** — or run the command raw /
175+ ` rtk proxy ` . The tiers keep ` rtk cargo test ` in * plain* mode, never aggressive.
176+ - ** Piped (non-TTY) output.** A harness captures stdout as a pipe. RTK can still
177+ emit icons/decoration there (RTK issue
178+ [ #1282 ] ( https://github.com/rtk-ai/rtk/issues/1282 ) ), which wastes tokens or
179+ corrupts parsed output. Run anything you'll parse ** raw** , and set ` NO_COLOR=1 `
180+ if decoration leaks in.
181+ - ** Streaming / follow.** RTK buffers output to filter it, so ` -f ` , ` tail -f ` , or
182+ a growing log can hang. Run those raw.
183+ - ** PATH.** A non-interactive shell may not find ` rtk ` ; the integration treats it
184+ as optional and falls back to the bare command, so a missing binary is a no-op,
185+ not a failure.
186+ - ** Native tools.** Command Code's built-in file/search tools (Read/Grep/Glob)
187+ are lossless, give line numbers, and don't pass through RTK — prefer them over
188+ ` rtk read/grep/find ` .
189+ - ** Permissions.** ` rtk ` (especially ` rtk proxy <cmd> ` ) can execute arbitrary
190+ wrapped commands, so an ` rtk ` allow-list entry is broad by nature — grant it
191+ deliberately.
192+ - ** Hooks on Windows.** RTK's filters work on Windows, but its auto-rewrite hook
193+ has gaps there (RTK
194+ [ discussion #671 ] ( https://github.com/rtk-ai/rtk/discussions/671 ) ); ` .ps1 ` stays
195+ CRLF per ` .gitattributes ` .
196+
197+ None of these corrupt your repository — the worst case is a failed or misread
198+ tool call that's recoverable by re-running raw.
199+
158200## Files
159201
160202```
@@ -170,6 +212,7 @@ rtk-command-code/
170212├── CONTRIBUTING.md # How to contribute
171213├── CODE_OF_CONDUCT.md # Contributor Covenant
172214├── SECURITY.md # Vulnerability reporting policy
215+ ├── CHANGELOG.md # Release history
173216├── LICENSE # Apache 2.0
174217└── README.md # This file
175218```
0 commit comments