help

Prints the usage summary: every command with a one-line description and every option. -h and --help do the same after any command.

Text

docgen help
docgen <command> --help

The command exits with status 0. An invalid command line prints the reason followed by the same summary and exits with status 2.

Example

Shell

pudu run examples/Cli.pudu help

Text

Usage: docgen [command] [path] [options]

Commands:
  [config]  Build the site, API reference included (the default)
  build [config]  The same as the default
  metadata [config]  Write API metadata files for the configured sources
  serve [folder]  Preview a built site over HTTP
  ...