Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IHelpGeneratorFactoryParms

Input to the help generator factory - normally built by imperative and passed to the command definition infrastructure - Each instance of the help generator is created with the command being issued (and the full command tree).

export
interface

IHelpGeneratorFactoryParms

Hierarchy

  • IHelpGeneratorFactoryParms

Index

Properties

Optional primaryHighlightColor

primaryHighlightColor: string

The primary highlight color - for the chalk package (coloring of console output)

memberof

IHelpGeneratorFactoryParms

Optional produceMarkdown

produceMarkdown: boolean

Produce a markdown file (rather than the normal help text output). Useful for providing CLI documentation

memberof

IHelpGeneratorFactoryParms

rootCommandName

rootCommandName: string

The root command for your CLI (i.e. the command that identifies your CLI/binary)

memberof

IHelpGeneratorFactoryParms

Generated using TypeDoc