search

jakeheis / SwiftCLI

A powerful framework for developing CLIs in Swift
MIT License
861 stars 72 forks source link

Print description in command help #62

Closed yonaskolb closed 6 years ago

yonaskolb commented 6 years ago

This adds the command description to it's help output

jakeheis commented 6 years ago

Command description should definitely be included in the help message -- I think it should be after the usage line though, that way it will have the same format as the CLI usage statement.

~ > ice

Usage: ice <command> [options]

ice package manager

Groups:

...

~ > ice build --help

Usage: ice build [options]

**Command description here**

Options:

...
yonaskolb commented 6 years ago

Yeah ok 👍 Also maybe we could have a longDescription for commands. If will show the long otherwise the short. This would let you describe the parameters as well, but still keep a short description for the command list. What do you think?

jakeheis commented 6 years ago

That sounds great to me! I think that's the best solution to #61 as well

jakeheis commented 6 years ago

Thanks for this, looks great!