docs(readme): document scope and limits#85
Merged
claudioemmanuel merged 1 commit intomainfrom Apr 22, 2026
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Added a new "Scope & Limits" section to README documenting what squeez can and cannot compress. Users often assume all token leaks are fixed — this clarifies the architectural boundaries (hook APIs expose only specific surfaces) and explains the workarounds.
Why
The
track_result.rscomment explains the core constraint:PostToolUsehooks are observation-only. squeez cannot rewrite an Agent's returned output. This architectural truth wasn't documented in README, leading to mismatched expectations. The section now explicitly lists what squeez covers (Bash, Read/Grep/Glob limits, agent prompts, session memory, markdown viewing) and what it cannot (Agent output, skills, top-level prompt, tools without hook support). Includes a coverage table and guidance on user-level cost reductions.