Improve knife --help with topic-based command groups - #195
Open
Chef-Pradyumn wants to merge 3 commits into
Open
Conversation
Signed-off-by: Chef-Pradyumn <264104377+Chef-Pradyumn@users.noreply.github.com>
Signed-off-by: Chef-Pradyumn <264104377+Chef-Pradyumn@users.noreply.github.com>
Signed-off-by: Chef-Pradyumn <264104377+Chef-Pradyumn@users.noreply.github.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
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
This PR improves the Knife help command experience by adding topic-based help navigation (access to the full command catalog is preserved under an '-all' flag.
The current default help output is long and difficult to scan quickly. The presence of plugin commands and other commands linked to very specific use-cases overwhelm the terminal and force users to scroll to reach the commands that they need help with. This change makes it easier for users to discover relevant commands fast, then drill into a focused command group when needed.
Changes
--help--help -allOutput
Below is the output for
knife --helpBelow is the output for
knife --help -infrafor example: