Repository navigation
docs: list termlens-cli in AGENTS.md's layout - #553
Merged
Merged
Conversation
AGENTS.md is the file coding agents read first, and its layout listed the library, the fixtures and the design doc but not the termlens command. Add the crate and note that the inspect example and its test must stay in step with termlens inspect. Signed-off-by: Cestercian <183791452+cestercian@users.noreply.github.com>
vyncint
approved these changes
Oct 4, 2026
vyncint
left a comment
Owner
There was a problem hiding this comment.
Thanks! I checked the bullet against the tree: both paths exist, the three subcommands are the CLI's real ones, it is published as termlens-cli, and tests/inspect.rs does check that the example and the command agree (six parity tests), so "a change to one needs the other" is accurate. The wrapping matches its neighbours.
CI was red on this PR for reasons unrelated to your change (an upstream action's moving v1 tag tripped the zizmor audit; fixed on main in #554). I updated your branch with it, so the re-run is all green. Merging.
Merged
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
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.
What & why
AGENTS.mdis the file coding agents read first. Its Layout section listed the library,fixtures/anddocs/DESIGN.mdbut notcrates/termlens-cli/, so an agent changingtermlens inspectortermlens renderwas not told where that code lives. This adds a bullet in the same style as the library's, and notes thatexamples/inspect.rsmirrorstermlens inspectandtests/inspect.rschecks that the two agree. Docs only.Closes #538
Checklist
cargo fmt --allandcargo clippy --workspace --all-targets --all-featuresare clean: no Rust changesgit commit -s)CHANGELOG.mdupdated under[Unreleased](user-facing changes only): n/a, docs onlycargo insta review, not blind-accepted: n/a.github/scripts/check-readme-links.shpasses on the edited files.