plm <subcommand> (without additional arguments) should print <subcommand>'s help #490

Closed
opened 5 years ago by igalic · 0 comments
igalic commented 5 years ago (Migrated from github.com)

currently, stepping thru plm's commandos is two step process

$ plm
Plume CLI 0.2.0
Collection of tools to manage your Plume instance.

USAGE:
    plm [SUBCOMMAND]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

SUBCOMMANDS:
    help        Prints this message or the help of the given subcommand(s)
    instance    Manage instances
    search      Manage search index
    users       Manage users⏎
$ plm instance
Unknown subcommand
$ plm instance --help
plm-instance 
Manage instances

USAGE:
    plm instance [SUBCOMMAND]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

SUBCOMMANDS:
    help    Prints this message or the help of the given subcommand(s)
    new     Create a new local instance

since our commands are non-interactive, i would expect plm <subcommand> to either error out, or else to provide help
note also how the plm vs plm --help prints different results:

--- /tmp/.psub.ah1wT4L8gr	2019-03-19 20:47:53.601753444 +0100
+++ /tmp/.psub.mKbavlHQpf	2019-03-19 20:47:53.609754105 +0100
@@ -12,4 +12,4 @@
     help        Prints this message or the help of the given subcommand(s)
     instance    Manage instances
     search      Manage search index
-    users       Manage users
\ No newline at end of file
+    users       Manage users
currently, stepping thru `plm`'s commandos is two step process ```sh-session $ plm Plume CLI 0.2.0 Collection of tools to manage your Plume instance. USAGE: plm [SUBCOMMAND] FLAGS: -h, --help Prints help information -V, --version Prints version information SUBCOMMANDS: help Prints this message or the help of the given subcommand(s) instance Manage instances search Manage search index users Manage users⏎ $ plm instance Unknown subcommand $ plm instance --help plm-instance Manage instances USAGE: plm instance [SUBCOMMAND] FLAGS: -h, --help Prints help information -V, --version Prints version information SUBCOMMANDS: help Prints this message or the help of the given subcommand(s) new Create a new local instance ``` since our commands are non-interactive, i would expect `plm <subcommand>` to either error out, or else to provide help note also how the `plm` vs `plm --help` prints different results: ```diff --- /tmp/.psub.ah1wT4L8gr 2019-03-19 20:47:53.601753444 +0100 +++ /tmp/.psub.mKbavlHQpf 2019-03-19 20:47:53.609754105 +0100 @@ -12,4 +12,4 @@ help Prints this message or the help of the given subcommand(s) instance Manage instances search Manage search index - users Manage users \ No newline at end of file + users Manage users ```
Sign in to join this conversation.
No Milestone
No Assignees
1 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: Plume/Plume#490
Loading…
There is no content yet.