docs: align README with the CLI surface - #636
Open
benvinegar wants to merge 1 commit into
Open
Conversation
The README advertised difftool support without setup instructions and omitted `hunk stash show`, `--staged`, and the hosted docs site. Add the missing surface, restructure the grab-bag Advanced section into clear Integrations and Configuration sections, and fold the loose config footnotes into the example so each section reads top to bottom. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01KHY9ReVesQXwKdRU47MwJ9
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
Greptile SummaryUpdates the README to align documentation with the current CLI surface.
Confidence Score: 5/5The documentation-only PR appears safe to merge. The newly added command examples, watch limitations, integration snippets, configuration claims, extension behavior, and OpenTUI export guidance are consistent with the repository implementation, and no actionable changed-code defect remains. Important Files Changed
Reviews (1): Last reviewed commit: "docs: align README with the CLI surface" | Re-trigger Greptile |
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.
Cleans up the README so it reflects the actual CLI surface and reads top to bottom.
hunk stash show,hunk diff --staged, and a Git difftool setup section (the features list advertised difftool support but never showed how to configure it).Every command, flag, config key, and integration snippet was fact-checked against
src/core/cli.ts,src/core/config.ts, and the loaders (33 claims verified, 0 inaccurate).🤖 Generated with Claude Code
https://claude.ai/code/session_01KHY9ReVesQXwKdRU47MwJ9
Generated by Claude Code