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

- primaryHighlightColor
- produceMarkdown
- rootCommandName

## Properties

### Optional primaryHighlightColor

primaryHighlightColor: string

- Defined in @zowe/imperative/src/cmd/src/help/doc/IHelpGeneratorFactoryParms.ts:37

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

memberof

  IHelpGeneratorFactoryParms

### Optional produceMarkdown

produceMarkdown: boolean

- Defined in @zowe/imperative/src/cmd/src/help/doc/IHelpGeneratorFactoryParms.ts:31

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

memberof

  IHelpGeneratorFactoryParms

### rootCommandName

rootCommandName: string

- Defined in @zowe/imperative/src/cmd/src/help/doc/IHelpGeneratorFactoryParms.ts:25

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

memberof

  IHelpGeneratorFactoryParms

Generated using TypeDoc