You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Command help is shown when a user adds the --help flag after a command. For Commando, I want to separate concerns between registering commands and command groups and their help information. Developers will define help in help.yaml file then commando will load the file and add help to the commands.
The yaml file should have the following format
parent child grand-childtype: commandshort-summary: "grand-child help"parameters:
- name: --bodyshort-summary: "itemBody"long-summary: | Usage: --body content=XX content-type=XX content: The content of the item.
- name: --endshort-summary: "dateTimeTimeZone"long-summary: | Usage: --end date-time=XX time-zone=XX
Running parent child grand-child --help will result in the output below
usage: parent child grand-child [-h|--help] --body <string> --end <string>
Arguments:
-h --help Print help information
--body itemBody
--end dateTimeTimeZone
The text was updated successfully, but these errors were encountered:
jobala
changed the title
Load help information from help.yaml
Command Help
Sep 4, 2022
Command help is shown when a user adds the
--help
flag after a command. For Commando, I want to separate concerns between registering commands and command groups and their help information. Developers will define help in help.yaml file then commando will load the file and add help to the commands.The yaml file should have the following format
Running
parent child grand-child --help
will result in the output belowThe text was updated successfully, but these errors were encountered: