Where should I put long help text?

[Niryo]

I want to add some long help text, that tells in details how to use some command.
The description prop should be short (because it's being printed from out side the command), and I see that the "usage" support is not the correct place for such a long help message...
what prop should I use?

[shadowspawn]

Have a look at the the README section on custom help which covers .addHelpText().

• https://github.com/tj/commander.js#custom-help

Related issues: #898 #1291

[Niryo]

thanks, it solved my problem. I think it worth considering adding an explicit prop for this, something like .extraInfo() or .detailedInfo() or even .documentation(). The current api for this is not intuitive.

[shadowspawn]

An answer was provided, and no further activity in a month. Closing this as resolved.

Feel free to open a new issue if it comes up again, with new information and renewed interest.

[shadowspawn]

Opened a PR to add .summary() for a short summary to use when listing subcommands.

[Niryo]

Amazing! Thanks