IBM Cloud - Structured Ideas


This portal is to open public enhancement requests against IBM Cloud and its products. To view all of your ideas submitted to IBM, create and manage groups of Ideas, or create an idea explicitly set to be either visible by all (public) or visible only to you and IBM (private), use the IBM Unified Ideas Portal (https://ideas.ibm.com).


Shape the future of IBM!

We invite you to shape the future of IBM, including product roadmaps, by submitting ideas that matter to you the most. Here's how it works:

Search existing ideas

Start by searching and reviewing ideas and requests to enhance a product or service. Take a look at ideas others have posted, and add a comment, vote, or subscribe to updates on them if they matter to you. If you can't find what you are looking for,

Post your ideas

  1. Post an idea.

  2. Get feedback from the IBM team and other customers to refine your idea.

  3. Follow the idea through the IBM Ideas process.


Specific links you will want to bookmark for future use

Welcome to the IBM Ideas Portal (https://www.ibm.com/ideas) - Use this site to find out additional information and details about the IBM Ideas process and statuses.

IBM Unified Ideas Portal (https://ideas.ibm.com) - Use this site to view all of your ideas, create new ideas for any IBM product, or search for ideas across all of IBM.

IBM Cloud Support Center (https://cloud.ibm.com/unifiedsupport/cases/form) – Use this site for any IBM Cloud defect or support need.

Stack Overflow (https://stackoverflow.com/questions/tagged/ibm-cloud) – Use this site for IBM Cloud technical Q&A using the tag "ibm-cloud".

ideasibm@us.ibm.com - Use this email to suggest enhancements to the Ideas process or request help from IBM for submitting your Ideas.

Add a new idea Subscribe
Status Not under consideration
Categories CLI
Created by Guest
Created on Feb 4, 2019

RELATED IDEAS

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

Idea priority Low
  • Guest
    Reply
    |     Mar 29, 2019

    The IBM SDK does not provide any support to print out the help in case of incorrect usage as recommended here: https://github.com/IBM-Cloud/ibm-cloud-cli-sdk/blob/master/docs/plugin_developer_guide.md#25-incorrect-usage 

     

    So if an invalid option combination is used, the IBM SDK help printout can't be triggered, hence as plugin developer, you have to code the print out again manually.

     

    We will stick to it, that we just print out: "invoke help" instead of maintaining the help output twice.

  • Guest
    Reply
    |     Mar 28, 2019

    The plugin should implement the help command so that they can define exactly what is shown to the user. This way, the plugin can update the help command if new commands are added/removed/modified. Please let me know if you have additional questions, or feel free to create an issue on the IBM Cloud CLI SDK repo, here: https://github.com/IBM-Cloud/ibm-cloud-cli-sdk

    Marking this idea as Closed.

  • Guest
    Reply
    |     Mar 20, 2019

    it would be nice, if the plugin developer would not to have to maintain two places of help output.

    We will stick to it, that we don't generate any manual help output, as long IBM does not provide any easy way to reuse their help output. Instead we will advide the IBM CLI user to invoke the help command. That is not user-friendly, but it would reduce the risk of getting out of sync regarding the two help outputs.

  • Guest
    Reply
    |     Mar 19, 2019

    For the help message, both the core CLI and plugin can build the help message. If the plugin has the help command implemented, then the core CLI will delegate to the plugin, otherwise the core CLI will show the help message. Specific help output should be done by the plugin since the plugin will know exactly which options are required and which are not. Does this help answer your questions?

By clicking the "Post Comment" or "Submit Idea" button, you are agreeing to the IBM Ideas Portal Terms of Use.
Do not place IBM confidential, company confidential, or personal information into any field.