docs: recommend cargo install termlens-cli --locked - #552
Merged
Merged
Conversation
The README and the skill were the two places that suggested a bare cargo install. Everything else (the CLI README, the install workflow, the report action) already passes --locked, so the recommended path resolved dependencies the release was never tested with. 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! Both edits are the two places the issue named, and nothing else in the tree recommends a bare install: the remaining mentions describe the release check or sit in comments, and everything that runs it already passes --locked. The diff is exactly the two lines.
CI was red on this PR and on every other one when you opened it, for reasons unrelated to your change: an upstream action's v1 tag had moved, which tripped the zizmor audit, and a separate test race (now #555) tripped the features job once. The first is fixed on main (#554) and I updated your branch with it, so the re-run is all green. Merging.
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
The README and the skill's section 9b were the two places that recommended a bare
cargo install termlens-cli. The CLI's own README, the daily install workflow and the report action all pass--locked, so the recommended path used the newest compatible dependencies instead of the set the release was tested with. Both lines now saycargo install termlens-cli --locked. Docs only.Closes #541
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.