[openstack-dev] openstack command line and --help for subcommands

Steve Martinelli stevemar at ca.ibm.com
Thu Jul 9 03:27:53 UTC 2015

Sean, Dean and I spoke about this at the last summit and we agreed that
--help should be included. I wanted to do this work item, but other
priorities came up, if you're happy to do the code, I'll be happy to review


Steve Martinelli
OpenStack Keystone Core

From:	"Perry, Sean" <sean.perry at hp.com>
To:	"openstack-dev at lists.openstack.org"
            <openstack-dev at lists.openstack.org>
Date:	2015/07/08 07:53 PM
Subject:	[openstack-dev] openstack command line and --help for

There are two similar tickets marked as invalid: 1444983 and 1251290. Both
discuss the fact that ?openstack subcommand function ?help? does not work.
Try ?openstack service list ?format foo?. You get the help output. It even
says that ?h provides help. But it is ignored and you get the global help.
That is not good UX. Both tickets are closed because ?openstack help
service list? is supposed to be the proper usage. It is my opinion that is
wrong. Users actually expect ?help to work as witnessed by two tickets over
3 years. Others like me would have opened a ticket had they not found the
existing one. If using the help verb is the only way to get help then the
help output needs to stop recommending ?h. But really, the help verb should
list the possible verbs and ?help should be used for the individual
subcommands. This is how many, many other CLIs work so admins the world
over expect it.

Yes, I will step up and do the coding if the patch will be accepted.

If there is some other place to argue the UX aspects please direct me

OpenStack Development Mailing List (not for usage questions)
Unsubscribe: OpenStack-dev-request at lists.openstack.org?subject:unsubscribe

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20150708/0d1b29ec/attachment.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: graycol.gif
Type: image/gif
Size: 105 bytes
Desc: not available
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20150708/0d1b29ec/attachment.gif>

More information about the OpenStack-dev mailing list