Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cf help <alias> should work for commands contributed by plugins #1048

Closed
glyn opened this issue Jan 5, 2017 · 5 comments
Closed

cf help <alias> should work for commands contributed by plugins #1048

glyn opened this issue Jan 5, 2017 · 5 comments

Comments

@glyn
Copy link
Contributor

glyn commented Jan 5, 2017

cf help r prints the help for cf routes since r is an alias for the routes command.

If a CLI plugin contributes a command with an alias xxx, cf help xxx fails with:

'xxx' is not a registered command. See 'cf help'

We are developing a plugin with a number of commands which have fairly long, descriptive names (e.g., service-registry-list) and short aliases (e.g., srl) and it would save some typing and improve usability for users who are familiar with an alias if they were able to get help via the alias (e.g., cf help srl).

@cf-gitbot
Copy link

We have created an issue in Pivotal Tracker to manage this:

https://www.pivotaltracker.com/story/show/137086223

The labels on this github issue will be updated when the story is started.

@glyn
Copy link
Contributor Author

glyn commented Jan 5, 2017

Please note the this is an enhancement (and is labelled as such) so story #137086223 should be a feature rather than a bug (unless the current behaviour is unintentional!).

@dkoper
Copy link

dkoper commented Jan 5, 2017

Hi @glyn

Thanks for reporting this!
I can't remember whether this was a limitation we defered for later, or we just forgot to test.

Our current command line parser library is statically populated with command info so certain features provided by this library do not work out of the box for plugins (which are discovered dynamically when the CLI process starts).
I'll ask the team to look into it. (and leave it as an enhancement)

Cheers,
Dies Koper
CF CLI PM

@dkoper
Copy link

dkoper commented Feb 28, 2017

We have addressed this in the cf CLI 6.25.0 release.
https://github.com/cloudfoundry/cli#downloads

Regards,
Dies Koper
CF CLI PM

@glyn
Copy link
Contributor Author

glyn commented Feb 28, 2017

Thanks @dkoper! I'm really pleased to see this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants