feat(config): add 'describe' mode to config command for detailed parameter info#476
Merged
di-sukharev merged 1 commit intodi-sukharev:masterfrom May 30, 2025
Merged
Conversation
…meter info This commit adds a new 'describe' mode to the config command, allowing users to get detailed information about configuration parameters. It includes: 1. New CONFIG_MODES.describe enum value 2. Functions to generate and print help messages for config parameters 3. Updated configCommand to handle the new 'describe' mode 4. README updates to document the new 'describe' functionality
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 commit adds a new 'describe' mode to the config command, allowing users to get detailed information about configuration parameters. It includes:
The
describemode can be used in two ways:To print help for all available config parameters:
oco config describeTo print help for specific config parameters:
oco config describe OCO_MODEL OCO_API_KEYAdditionally, the commit fixes the error handling for the
getandsetmodes, ensuring that an error is thrown if no config keys are provided.These changes improve the usability and discoverability of the configuration system, making it easier for users to understand and manage their opencommit settings.
See #470
Example Usage