Repository navigation
feat: enhance help command with examples and exit codes section - #67
Merged
Merged
Conversation
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.
This pull request introduces several improvements to the CLI user experience, focusing on clearer help output, more structured and modular flag binding, and enhanced discoverability through command examples. The most significant changes include the addition of an exit codes section to the root help, modularization of command flag groups, improved help and usage text, and expanded usage examples for key commands.
Help Output and Usage Improvements:
Command Flag Binding Refactor:
BindCommandFlagGroups, allowing commands to specify which logical groups of flags they support. This improves flag organization and ensures only relevant flags are available per command. [1] [2] [3] [4] [5] [6] [7] [8]Command Examples and Messaging:
Exampleusage strings to thediff,explain, andplugincommands and subcommands to improve user onboarding and clarify command usage. [1] [2] [3] [4] [5]Internal Refactoring and Consistency:
diffcommand.These changes collectively make the CLI more user-friendly, maintainable, and informative.