Repository navigation
docs(hooks): add "reading the full output" to agent instructions - #2156
tiagodocouto wants to merge 1 commit into
Conversation
Agent instruction files explained how to run commands through rtk but not how to recover the complete, unfiltered output when the filtered summary is not enough (e.g. to confirm a test or build claim). Add a short "Reading the full output" section to every agent template, pointing to `rtk proxy <cmd>` and the `[full output: <path>]` tee log. The Claude template also swaps its dangling "Refer to CLAUDE.md" line for `rtk --help`.
63c731a to
eab667c
Compare
|
This pull request has been automatically marked as stale due to 90 days of inactivity. If this pull request is still relevant, please leave any comment (for example, "bump"), and we'll keep it open. Your contribution is very much appreciated — we're sorry we haven't been able to review it yet. |
|
Thanks for writing this up. The per-agent instruction templates were consolidated into a single agent-neutral hooks/rtk-awareness.md in #3372, merged 2026-09-07, and that file already tells the agent that truncated results state their own recovery path and to re-run a command as |
Summary
hooks/*/rtk-awareness.mdandrules.md). The templates tell agents to run commands throughrtk, but not how to recover the complete, unfiltered output when the filtered summary isn't enough — e.g. to confirm a "tests pass" / "build clean" claim rather than skim it. Both raw paths already exist (rtk proxy <cmd>and the[full output: <path>]tee log) but weren't documented where agents actually read. Mirrors the principle already inCONTRIBUTING.md(respect explicitly-requested detail).Refer to CLAUDE.mdline withrtk --help.Test plan
cargo fmt --all && cargo clippy --all-targets && cargo test— fmt clean, test 1974 passed, 0 failed. (clippy hits a pre-existinguninlined_format_argslint inbuild.rs, untouched by this docs-only diff; CI is green ondevelop.)rtk cargo test(filtered) vsrtk proxy cargo test(raw) vs the[full output: <path>]tee log against a failing and a non-compiling crate — the documented behavior matches.