Show help text programmatically

[danguilherme]

Expose a method to show the help string whenever I want to, like it being the default command of my program.

Program would be something like:

program
  .version(package.version)
  .action(() => program.showHelp())
  .command('real command')
  .action((args, options, logger) => /* do stuff */);
program.parse(process.argv);

// ./myprog
/* ... prints help ... */

I managed to print the help text using the private _help function, but as it's private and not documented, I believe it's not good to stick to it.

[beorn]

I agree, another way to do this is to make the help command the default command:

(await program.getAllCommands())
  .filter((cmd) => cmd.name === "help")[0]
  .default()

Yet another way could be to manually invoke the help command if you detect that no args were given.

It'd be great if all of these options should ideally be possible through a more documented API — maybe something like this?

program.commands.help.default() // set help command as default
program.commands.help.run() // run help command