fix(cli): add detailed --help documentation for agent create command#62
Merged
fix(cli): add detailed --help documentation for agent create command#62
Conversation
Fixes bounty issue #1396 The 'cortex agent create --help' command previously only displayed 'Create a new agent interactively' without explaining what fields the interactive wizard would ask for. This commit adds: - Comprehensive long_about text documenting required vs optional fields - after_help with usage examples - Enhanced doc comments on CreateArgs fields explaining their purpose - Value names for better help output clarity
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
2 participants
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 adds comprehensive help documentation for the
cortex agent createcommand, which previously only showed "Create a new agent interactively" without explaining what fields would be prompted.Changes
long_aboutattribute with detailed explanation of required vs optional fieldsafter_helpattribute with usage examplesWhat Users Will See
After this fix, running
cortex agent create --helpwill show:Related
Fixes PlatformNetwork/bounty-challenge#1396