docs: put first move in gw -h and enrich subcommand help - #42
Merged
Conversation
Close the two remaining CLI_REVIEW gaps for gw:
- Rule 6: -h now shows the first command ("Start here: gw new feature/login"),
not just --help, so the on-ramp is in the reflex view.
- Rule 14: every subcommand --help gains a description paragraph + Example,
matching the now-rich root. Covers home/new/cleanup/status/pause/abandon/
undo/sync/open/await and the worktree pool commands, removing the
rich-root / bare-subcommand asymmetry. Each -h stays the compact summary
and signals "(see more with '--help')".
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
Closes the two remaining gw findings from the CLI_REVIEW re-evaluation (gw 9.0 → target 10), building on #41.
Rule 6 — first move in
-h-hpreviously showed only the purpose line; the on-ramp was--help-only. Now-hleads with the first command:Rule 14 — enrich subcommand
--helpThe root help got rich in #41 while subcommands stayed bare — an asymmetry the review flagged. Every subcommand
--helpnow carries a description paragraph + anExample:block:home, new, cleanup, status, pause, abandon, undo, sync, open, await, plusworktree/worktree pool {warm,acquire,status,release,drain}. Destructive ones restate the danger (gw abandon,gw sync"rewrites history and force-pushes").Progressive disclosure is preserved: each subcommand
-hstays the one-line summary and signals(see more with '--help').Verification
mise run verifypasses (fmt, clippy, tests, build). Spot-checkedgw -h,gw new -h/--help,gw sync --help,gw abandon -h,gw worktree pool acquire --help.🤖 Generated with Claude Code