feat: add opt-in help-all command (ref #2362)#2370
Open
dpritchett wants to merge 2 commits intospf13:mainfrom
Open
feat: add opt-in help-all command (ref #2362)#2370dpritchett wants to merge 2 commits intospf13:mainfrom
dpritchett wants to merge 2 commits intospf13:mainfrom
Conversation
Add NewHelpAllCommand() factory that prints every visible, runnable command with args and description in one pass — the cobra equivalent of `rake routes`. Supports --verbose to include flag placeholders. Ref: spf13#2362
ccoVeille
reviewed
Mar 20, 2026
Comment on lines
+152
to
+156
| func NewHelpAllCommand() *Command { | ||
| var verbose bool | ||
|
|
||
| cmd := &Command{ | ||
| Use: "help-all", |
Contributor
There was a problem hiding this comment.
if we go in that direction I would use something like
Suggested change
| func NewHelpAllCommand() *Command { | |
| var verbose bool | |
| cmd := &Command{ | |
| Use: "help-all", | |
| func NewHelpAllCommand(argName s) *Command { | |
| var verbose bool | |
| cmd := &Command{ | |
| Use: argName, |
There is no need to fix the positional argument to be "help-all", some users may want to use "help" or whatever they want
Author
There was a problem hiding this comment.
Good point, thanks. I've added a godoc example showing that the name is customizable via .Use on the returned *Command (see 8902815). This matches how cobra's own completion command works internally (hardcoded default name, mutable after creation).
ccoVeille
approved these changes
Mar 21, 2026
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.
Summary
Adds
NewHelpAllCommand()— an opt-in command that prints every visible, runnable command with args and description in one pass. Same wiring pattern ascompletion:--verboseadds flag placeholders with type-aware formattingContext in #2362 (see my comment). Gist with
ghoutput (~200 commands).Example (patched into a local clone of
gh)Full gist with ~200 commands
What's here
helpall.go: factory, tree walker, formatter, rendererhelpall_test.go: 19 testsRoadmap
ghCLIsite/content/if accepted