Skip to Main content

tuyen dev doc

Generate HTML documentation for a CLI program from its --help output.

Usage

tuyen dev doc [OPTIONS] --program <PROGRAM>

Options

-p, --program <PROGRAM>

  • Name of the CLI program to generate documentation for.
  • Required: Yes.

--front-matter

  • Include YAML front matter in the generated HTML files.
  • Default value: false.
  • Possible values: true, false.

--no-title

  • Omit the command title heading from each generated page.
  • Default value: false.
  • Possible values: true, false.

--hidden

  • Mark the generated files as hidden in the front matter.
  • Default value: false.
  • Possible values: true, false.

-c, --command <COMMAND>

  • Comma-separated list of subcommands to generate docs for. If empty, all subcommands are included.

-h, --help

  • Print help.