Cheer.Help (Cheer v0.1.5)

Copy Markdown View Source

Auto-generates help text from command metadata.

Renders a formatted help page to stdout including usage line, description, subcommands, arguments, options (with defaults, env vars, choices), param groups, and built-in flags (--help, --version).

Supports short help (-h) and long help (--help) modes. When long help is available (via long_about or long_help), --help displays the extended version while -h displays the short version.

Summary

Functions

print(command, opts \\ [])

Print formatted help for a command to stdout.

Functions

print(command, opts \\ [])

@spec print(
  module(),
  keyword()
) :: :ok

Print formatted help for a command to stdout.

Options:

  • :prog - program name for usage line (default: command name)
  • :long - true to print long help (default: false)