search

Nexmo / nexmo-cli

Nexmo CLI (Command Line Interface)
https://nexmo.com
MIT License
78 stars 52 forks source link

fix(chore): fixup usage info #211

Closed jamesgeorge007 closed 4 years ago

jamesgeorge007 commented 4 years ago

Summary

Usage: nexmo <command> [options] makes a lot more sense.

Other Information

N/A

mheap commented 4 years ago

I'm not sure that I agree here. The [options] are related to the whole CLI, not to the command.

It feels more like nexmo [options] <command> [arguments] to me (though options can be provided anywhere)

jamesgeorge007 commented 4 years ago

Most of the CLI utilities out there follow a simlilar approach. Say, Vue-CLI

lornajane commented 4 years ago

We're not redesigning the CLI here though, we need to describe accurately how this CLI currently works. It currently gives its usage info as:

Usage: nexmo [options] [command]

There are options and then commands (some of which themselves include options/arguments as well) listed. Supplying --help to any command then gives the usage for that command.

I think the current usage documentation better represents the behaviour of the tool than this pull request so while we love getting pull requests, I will close this one.