Skip to content

docs: list termlens-cli in AGENTS.md's layout - #553

Merged
vyncint merged 2 commits into
vyncint:mainfrom
cestercian:docs/agents-layout-cli
Oct 4, 2026
Merged

vyncint merged 2 commits into
vyncint:mainfrom
cestercian:docs/agents-layout-cli

Conversation

@cestercian

Copy link
Copy Markdown
Contributor

What & why

AGENTS.md is the file coding agents read first. Its Layout section listed the library, fixtures/ and docs/DESIGN.md but not crates/termlens-cli/, so an agent changing termlens inspect or termlens render was not told where that code lives. This adds a bullet in the same style as the library's, and notes that examples/inspect.rs mirrors termlens inspect and tests/inspect.rs checks that the two agree. Docs only.

Closes #538

Checklist

  • Linked an issue (or explained above why none exists)
  • Tests added/updated for the change: n/a, one bullet
  • cargo fmt --all and cargo clippy --workspace --all-targets --all-features are clean: no Rust changes
  • All commits are signed off (git commit -s)
  • No AI attribution trailers
  • CHANGELOG.md updated under [Unreleased] (user-facing changes only): n/a, docs only
  • Snapshot changes (if any) were reviewed with cargo insta review, not blind-accepted: n/a

.github/scripts/check-readme-links.sh passes on the edited files.

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 vyncint left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@vyncint
vyncint merged commit cbf2ca8 into vyncint:main Oct 4, 2026
16 checks passed
@vyncint vyncint mentioned this pull request Oct 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: AGENTS.md's layout leaves out the termlens-cli crate

2 participants