IBM Cloud - Structured Ideas

Welcome to the idea portal for structured ideas (i.e. product feature requests) - A more integrated and automated feedback system to connect your product improvement ideas with IBM product and engineering teams.  Happy submitting!

 

NOTE: All IBM employees must enter Ideas through this Ideas Portal.

bx/automated help output

In your documentation is mentioned, that a command is incorrect usage should print out the help page:
https://github.com/IBM-Cloud/ibm-cloud-cli-sdk/blob/master/docs/plugin_developer_guide.md#25-incorrect-usage

The help page is defined by that structure of yours:
https://github.com/IBM-Cloud/ibm-cloud-cli-sdk/blob/master/docs/plugin_developer_guide.md#11-register-a-new-plug-in
--- SNIP ---
func (p *FssPlugin) GetMetadata() plugin.PluginMetadata {
// define plugin namespace
fssNamespace := plugin.Namespace{
Name: "mpl",
Description: "Doing stuff",
}
return plugin.PluginMetadata{
Name: "my.plugin",
Version: plugin.VersionType{
Major: 0,
Minor: 0,
Build: 1,
},
MinCliVersion: plugin.VersionType{
Major: 0,
Minor: 0,
Build: 1,
}, Namespaces: []plugin.Namespace{
fssNamespace,
},
Commands: []plugin.Command{
{
Namespace: fssNamespace.Name,
Name: "my-command",
Description: "Doing stuff",
Usage: "bx mpl my-command KEY VALUE\n KEY is the key of the configuration e.g. my-config\n VALUE is the value of the configuration e.g. fg",
Hidden: false,
}
...
--- SNAP ---

So it would be great, if we could just this information to build the help out instead of duplicate the text and generate an own help output

  • Guest
  • Feb 4 2019
  • Needs review
CLI
  • Attach files

NOTICE TO EU RESIDENTS: per EU Data Protection Policy, if you wish to remove your personal information from the IBM ideas portal, please login to the ideas portal using your previously registered information then change your email to "anonymous@euprivacy.out" and first name to "anonymous" and last name to "anonymous". This will ensure that IBM will not send any emails to you about all idea submissions