shell icon indicating copy to clipboard operation
shell copied to clipboard

Integrate help after plugin install and list plugins

Open allen-servedio opened this issue 7 years ago • 3 comments

After installing a plugin such as https://github.com/ibm-functions/shell-project-plugin, the commands it enables are not visible (so, in the case of the shell-project-plugin it should surface the project commands).

Also, it would be good to have someone in the shell docs that plugins even exist and how to find them: https://github.com/ibm-functions?q=plugin

allen-servedio avatar Mar 06 '18 20:03 allen-servedio

@allen-servedio what version of fsh do you have? You should get help with the latest fsh 1.3.423.

lionelvillard avatar Mar 06 '18 20:03 lionelvillard

I am on the latest:

$ fsh version -u
You are currently on version 1.3.423
Checking for updates... you are up to date!

However, I do not see help for the installed plugin.

$ fsh help
Shell Docs / Getting Started
A summary of the top-level command structure. Select an available command to learn more.

Available Commands
composer/   Create and invoke complex applications
editor/     In-shell editing operations
local/      Local activations and debugging
visualize/  Activation visualizations
wsk/        The fundamental OpenWhisk operations

I looked under each of these and there is no project command help suggested at the top level. However, if I know what to type, I can get some help:

$ fsh project help
Command related to projects.
	project add                          [ Add project to the shell ]
	project set                          [ Set current project ]
	project unset                        [ Unset current project ]
	project remove                       [ Remove project from the shell ]
	project list                         [ List projects added to the shell ]
	project deploy                       [ Deploy project ]
	project undeploy                     [ Undeploy project ]

The CLI should tell me that there is a project command at least at the top level.

Also, it would be good to expose that there are plugins to be downloaded (that is not documented anywhere).

allen-servedio avatar Mar 07 '18 12:03 allen-servedio

The work on improving help is very recent and I didn't release the project plugin based on the new help framework.

I open #590 to address your last point.

lionelvillard avatar Mar 07 '18 14:03 lionelvillard