Skip to content

Interface: CommandHelpOptions

Defined in: packages/plugin-help/src/index.ts:21

Extends

Properties

PropertyTypeDescriptionInherited fromDefined in
examples?[string, string][]Examples to show in the help output. Each example is a tuple of [command, description].-packages/plugin-help/src/index.ts:36
group?stringThe group this item belongs to. The group must be defined in the groups option of helpPlugin().HelpOptions.grouppackages/plugin-help/src/index.ts:18
notes?string[]Notes to show in the help output.-packages/plugin-help/src/index.ts:31
show?booleanWhether to show the command in help output. Default true-packages/plugin-help/src/index.ts:27

Released under the MIT license