Module: help

Classes

• HelpGenerator

Type Aliases

GenerateTableCommandConfig

Ƭ GenerateTableCommandConfig: z.infer<typeof GenerateTableCommandConfig>

Defined in

src/help.ts:7

src/help.ts:21

---

GenerateTableOptionConfig

Ƭ GenerateTableOptionConfig: z.infer<typeof GenerateTableOptionConfig>

Defined in

src/help.ts:23

src/help.ts:33

---

HelpConfig

Ƭ HelpConfig: z.infer<typeof HelpConfig>

Defined in

src/help.ts:35

src/help.ts:113

---

HelpItem

Ƭ HelpItem: Object

Type declaration

Name	Type
name	string
negationName?	string
aliases	string[]
negationAliases?	string[]
description	string
hidden?	boolean
negatable?	boolean
defaultValue?	any

Defined in

src/help.ts:193

Variables

GenerateTableCommandConfig

• Const GenerateTableCommandConfig: ZodObject<{ lineLength: ZodOptional<ZodNumber> ; compact: ZodOptional<ZodBoolean> ; nameStyle: ZodOptional<ZodObject<{ bold: ZodOptional<ZodBoolean> ; underline: ZodOptional<ZodBoolean> ; color: ZodOptional<ZodEnum<{ red: "red" ; green: "green" ; yellow: "yellow" ; blue: "blue" ; magenta: "magenta" ; cyan: "cyan" ; white: "white" ; gray: "gray" ; grey: "grey" ; brightRed: "brightRed" ; brightGreen: "brightGreen" ; brightYellow: "brightYellow" ; brightBlue: "brightBlue" ; brightMagenta: "brightMagenta" ; brightCyan: "brightCyan" ; brightWhite: "brightWhite" }>> ; reset: ZodOptional<ZodDefault<ZodBoolean>> }, $strip>> ; descriptionStyle: ZodOptional<ZodObject<{ bold: ZodOptional<ZodBoolean> ; underline: ZodOptional<ZodBoolean> ; color: ZodOptional<ZodEnum<{ red: "red" ; green: "green" ; yellow: "yellow" ; blue: "blue" ; magenta: "magenta" ; cyan: "cyan" ; white: "white" ; gray: "gray" ; grey: "grey" ; brightRed: "brightRed" ; brightGreen: "brightGreen" ; brightYellow: "brightYellow" ; brightBlue: "brightBlue" ; brightMagenta: "brightMagenta" ; brightCyan: "brightCyan" ; brightWhite: "brightWhite" }>> ; reset: ZodOptional<ZodDefault<ZodBoolean>> }, $strip>> ; namePrefix: ZodOptional<ZodString> ; aliasPrefix: ZodOptional<ZodString> }, $strip>

Defined in

src/help.ts:7

src/help.ts:21

---

GenerateTableOptionConfig

• Const GenerateTableOptionConfig: ZodObject<{ lineLength: ZodOptional<ZodNumber> ; compact: ZodOptional<ZodBoolean> ; nameStyle: ZodOptional<ZodObject<{ bold: ZodOptional<ZodBoolean> ; underline: ZodOptional<ZodBoolean> ; color: ZodOptional<ZodEnum<{ red: "red" ; green: "green" ; yellow: "yellow" ; blue: "blue" ; magenta: "magenta" ; cyan: "cyan" ; white: "white" ; gray: "gray" ; grey: "grey" ; brightRed: "brightRed" ; brightGreen: "brightGreen" ; brightYellow: "brightYellow" ; brightBlue: "brightBlue" ; brightMagenta: "brightMagenta" ; brightCyan: "brightCyan" ; brightWhite: "brightWhite" }>> ; reset: ZodOptional<ZodDefault<ZodBoolean>> }, $strip>> ; descriptionStyle: ZodOptional<ZodObject<{ bold: ZodOptional<ZodBoolean> ; underline: ZodOptional<ZodBoolean> ; color: ZodOptional<ZodEnum<{ red: "red" ; green: "green" ; yellow: "yellow" ; blue: "blue" ; magenta: "magenta" ; cyan: "cyan" ; white: "white" ; gray: "gray" ; grey: "grey" ; brightRed: "brightRed" ; brightGreen: "brightGreen" ; brightYellow: "brightYellow" ; brightBlue: "brightBlue" ; brightMagenta: "brightMagenta" ; brightCyan: "brightCyan" ; brightWhite: "brightWhite" }>> ; reset: ZodOptional<ZodDefault<ZodBoolean>> }, $strip>> ; namePrefix: ZodOptional<ZodString> ; aliasPrefix: ZodOptional<ZodString> ; displayNegations: ZodOptional<ZodBoolean> ; displayDefaultValue: ZodOptional<ZodBoolean> ; defaultValueStyle: ZodOptional<ZodObject<{ bold: ZodOptional<ZodBoolean> ; underline: ZodOptional<ZodBoolean> ; color: ZodOptional<ZodEnum<{ red: "red" ; green: "green" ; yellow: "yellow" ; blue: "blue" ; magenta: "magenta" ; cyan: "cyan" ; white: "white" ; gray: "gray" ; grey: "grey" ; brightRed: "brightRed" ; brightGreen: "brightGreen" ; brightYellow: "brightYellow" ; brightBlue: "brightBlue" ; brightMagenta: "brightMagenta" ; brightCyan: "brightCyan" ; brightWhite: "brightWhite" }>> ; reset: ZodOptional<ZodDefault<ZodBoolean>> }, $strip>> }, $strip>

Defined in

src/help.ts:23

src/help.ts:33

---

HelpConfig

• Const HelpConfig: ZodObject<{ bindCommand: ZodOptional<ZodBoolean> ; bindOption: ZodOptional<ZodBoolean> ; useGlobalTableColumns: ZodOptional<ZodDefault<ZodBoolean>> ; commandOptions: ZodOptional<ZodObject<{ compact: ZodOptional<ZodBoolean> ; nameStyle: ZodOptional<ZodObject<{ bold: ZodOptional<ZodBoolean> ; underline: ZodOptional<ZodBoolean> ; color: ZodOptional<ZodEnum<{ red: ... ; green: ... ; yellow: ... ; blue: ... ; magenta: ... ; cyan: ... ; white: ... ; gray: ... ; grey: ... ; brightRed: ... ; brightGreen: ... ; brightYellow: ... ; brightBlue: ... ; brightMagenta: ... ; brightCyan: ... ; brightWhite: ... }>> ; reset: ZodOptional<ZodDefault<ZodBoolean>> }, $strip>> ; descriptionStyle: ZodOptional<ZodObject<{ bold: ZodOptional<ZodBoolean> ; underline: ZodOptional<ZodBoolean> ; color: ZodOptional<ZodEnum<{ red: ... ; green: ... ; yellow: ... ; blue: ... ; magenta: ... ; cyan: ... ; white: ... ; gray: ... ; grey: ... ; brightRed: ... ; brightGreen: ... ; brightYellow: ... ; brightBlue: ... ; brightMagenta: ... ; brightCyan: ... ; brightWhite: ... }>> ; reset: ZodOptional<ZodDefault<ZodBoolean>> }, $strip>> ; namePrefix: ZodOptional<ZodString> ; aliasPrefix: ZodOptional<ZodString> }, $strip>> ; optionOptions: ZodOptional<ZodObject<{ compact: ZodOptional<ZodBoolean> ; nameStyle: ZodOptional<ZodObject<{ bold: ZodOptional<ZodBoolean> ; underline: ZodOptional<ZodBoolean> ; color: ZodOptional<ZodEnum<{ red: ... ; green: ... ; yellow: ... ; blue: ... ; magenta: ... ; cyan: ... ; white: ... ; gray: ... ; grey: ... ; brightRed: ... ; brightGreen: ... ; brightYellow: ... ; brightBlue: ... ; brightMagenta: ... ; brightCyan: ... ; brightWhite: ... }>> ; reset: ZodOptional<ZodDefault<ZodBoolean>> }, $strip>> ; descriptionStyle: ZodOptional<ZodObject<{ bold: ZodOptional<ZodBoolean> ; underline: ZodOptional<ZodBoolean> ; color: ZodOptional<ZodEnum<{ red: ... ; green: ... ; yellow: ... ; blue: ... ; magenta: ... ; cyan: ... ; white: ... ; gray: ... ; grey: ... ; brightRed: ... ; brightGreen: ... ; brightYellow: ... ; brightBlue: ... ; brightMagenta: ... ; brightCyan: ... ; brightWhite: ... }>> ; reset: ZodOptional<ZodDefault<ZodBoolean>> }, $strip>> ; namePrefix: ZodOptional<ZodString> ; aliasPrefix: ZodOptional<ZodString> ; displayNegations: ZodOptional<ZodBoolean> ; displayDefaultValue: ZodOptional<ZodBoolean> ; defaultValueStyle: ZodOptional<ZodObject<{ bold: ZodOptional<ZodBoolean> ; underline: ZodOptional<ZodBoolean> ; color: ZodOptional<ZodEnum<{ red: ... ; green: ... ; yellow: ... ; blue: ... ; magenta: ... ; cyan: ... ; white: ... ; gray: ... ; grey: ... ; brightRed: ... ; brightGreen: ... ; brightYellow: ... ; brightBlue: ... ; brightMagenta: ... ; brightCyan: ... ; brightWhite: ... }>> ; reset: ZodOptional<ZodDefault<ZodBoolean>> }, $strip>> }, $strip>> ; titleStyle: ZodOptional<ZodObject<{ bold: ZodOptional<ZodBoolean> ; underline: ZodOptional<ZodBoolean> ; color: ZodOptional<ZodEnum<{ red: "red" ; green: "green" ; yellow: "yellow" ; blue: "blue" ; magenta: "magenta" ; cyan: "cyan" ; white: "white" ; gray: "gray" ; grey: "grey" ; brightRed: "brightRed" ; brightGreen: "brightGreen" ; brightYellow: "brightYellow" ; brightBlue: "brightBlue" ; brightMagenta: "brightMagenta" ; brightCyan: "brightCyan" ; brightWhite: "brightWhite" }>> ; reset: ZodOptional<ZodDefault<ZodBoolean>> }, $strip>> ; descriptionStyle: ZodOptional<ZodObject<{ bold: ZodOptional<ZodBoolean> ; underline: ZodOptional<ZodBoolean> ; color: ZodOptional<ZodEnum<{ red: "red" ; green: "green" ; yellow: "yellow" ; blue: "blue" ; magenta: "magenta" ; cyan: "cyan" ; white: "white" ; gray: "gray" ; grey: "grey" ; brightRed: "brightRed" ; brightGreen: "brightGreen" ; brightYellow: "brightYellow" ; brightBlue: "brightBlue" ; brightMagenta: "brightMagenta" ; brightCyan: "brightCyan" ; brightWhite: "brightWhite" }>> ; reset: ZodOptional<ZodDefault<ZodBoolean>> }, $strip>> ; subtitleStyle: ZodOptional<ZodObject<{ bold: ZodOptional<ZodBoolean> ; underline: ZodOptional<ZodBoolean> ; color: ZodOptional<ZodEnum<{ red: "red" ; green: "green" ; yellow: "yellow" ; blue: "blue" ; magenta: "magenta" ; cyan: "cyan" ; white: "white" ; gray: "gray" ; grey: "grey" ; brightRed: "brightRed" ; brightGreen: "brightGreen" ; brightYellow: "brightYellow" ; brightBlue: "brightBlue" ; brightMagenta: "brightMagenta" ; brightCyan: "brightCyan" ; brightWhite: "brightWhite" }>> ; reset: ZodOptional<ZodDefault<ZodBoolean>> }, $strip>> ; usageStyle: ZodOptional<ZodObject<{ prefix: ZodOptional<ZodObject<{ bold: ZodOptional<ZodBoolean> ; underline: ZodOptional<ZodBoolean> ; color: ZodOptional<ZodEnum<{ red: ... ; green: ... ; yellow: ... ; blue: ... ; magenta: ... ; cyan: ... ; white: ... ; gray: ... ; grey: ... ; brightRed: ... ; brightGreen: ... ; brightYellow: ... ; brightBlue: ... ; brightMagenta: ... ; brightCyan: ... ; brightWhite: ... }>> ; reset: ZodOptional<ZodDefault<ZodBoolean>> }, $strip>> ; main: ZodOptional<ZodObject<{ bold: ZodOptional<ZodBoolean> ; underline: ZodOptional<ZodBoolean> ; color: ZodOptional<ZodEnum<{ red: ... ; green: ... ; yellow: ... ; blue: ... ; magenta: ... ; cyan: ... ; white: ... ; gray: ... ; grey: ... ; brightRed: ... ; brightGreen: ... ; brightYellow: ... ; brightBlue: ... ; brightMagenta: ... ; brightCyan: ... ; brightWhite: ... }>> ; reset: ZodOptional<ZodDefault<ZodBoolean>> }, $strip>> ; command: ZodOptional<ZodObject<{ bold: ZodOptional<ZodBoolean> ; underline: ZodOptional<ZodBoolean> ; color: ZodOptional<ZodEnum<{ red: ... ; green: ... ; yellow: ... ; blue: ... ; magenta: ... ; cyan: ... ; white: ... ; gray: ... ; grey: ... ; brightRed: ... ; brightGreen: ... ; brightYellow: ... ; brightBlue: ... ; brightMagenta: ... ; brightCyan: ... ; brightWhite: ... }>> ; reset: ZodOptional<ZodDefault<ZodBoolean>> }, $strip>> ; options: ZodOptional<ZodObject<{ bold: ZodOptional<ZodBoolean> ; underline: ZodOptional<ZodBoolean> ; color: ZodOptional<ZodEnum<{ red: ... ; green: ... ; yellow: ... ; blue: ... ; magenta: ... ; cyan: ... ; white: ... ; gray: ... ; grey: ... ; brightRed: ... ; brightGreen: ... ; brightYellow: ... ; brightBlue: ... ; brightMagenta: ... ; brightCyan: ... ; brightWhite: ... }>> ; reset: ZodOptional<ZodDefault<ZodBoolean>> }, $strip>> }, $strip>> ; headerStyle: ZodOptional<ZodObject<{ bold: ZodOptional<ZodBoolean> ; underline: ZodOptional<ZodBoolean> ; color: ZodOptional<ZodEnum<{ red: "red" ; green: "green" ; yellow: "yellow" ; blue: "blue" ; magenta: "magenta" ; cyan: "cyan" ; white: "white" ; gray: "gray" ; grey: "grey" ; brightRed: "brightRed" ; brightGreen: "brightGreen" ; brightYellow: "brightYellow" ; brightBlue: "brightBlue" ; brightMagenta: "brightMagenta" ; brightCyan: "brightCyan" ; brightWhite: "brightWhite" }>> ; reset: ZodOptional<ZodDefault<ZodBoolean>> }, $strip>> ; footerStyle: ZodOptional<ZodObject<{ bold: ZodOptional<ZodBoolean> ; underline: ZodOptional<ZodBoolean> ; color: ZodOptional<ZodEnum<{ red: "red" ; green: "green" ; yellow: "yellow" ; blue: "blue" ; magenta: "magenta" ; cyan: "cyan" ; white: "white" ; gray: "gray" ; grey: "grey" ; brightRed: "brightRed" ; brightGreen: "brightGreen" ; brightYellow: "brightYellow" ; brightBlue: "brightBlue" ; brightMagenta: "brightMagenta" ; brightCyan: "brightCyan" ; brightWhite: "brightWhite" }>> ; reset: ZodOptional<ZodDefault<ZodBoolean>> }, $strip>> ; lineLength: ZodOptional<ZodNumber> ; exampleOptions: ZodOptional<ZodObject<{ descriptionStyle: ZodOptional<ZodObject<{ bold: ZodOptional<ZodBoolean> ; underline: ZodOptional<ZodBoolean> ; color: ZodOptional<ZodEnum<{ red: ... ; green: ... ; yellow: ... ; blue: ... ; magenta: ... ; cyan: ... ; white: ... ; gray: ... ; grey: ... ; brightRed: ... ; brightGreen: ... ; brightYellow: ... ; brightBlue: ... ; brightMagenta: ... ; brightCyan: ... ; brightWhite: ... }>> ; reset: ZodOptional<ZodDefault<ZodBoolean>> }, $strip>> ; inputStyle: ZodOptional<ZodObject<{ bold: ZodOptional<ZodBoolean> ; underline: ZodOptional<ZodBoolean> ; color: ZodOptional<ZodEnum<{ red: ... ; green: ... ; yellow: ... ; blue: ... ; magenta: ... ; cyan: ... ; white: ... ; gray: ... ; grey: ... ; brightRed: ... ; brightGreen: ... ; brightYellow: ... ; brightBlue: ... ; brightMagenta: ... ; brightCyan: ... ; brightWhite: ... }>> ; reset: ZodOptional<ZodDefault<ZodBoolean>> }, $strip>> ; outputStyle: ZodOptional<ZodObject<{ bold: ZodOptional<ZodBoolean> ; underline: ZodOptional<ZodBoolean> ; color: ZodOptional<ZodEnum<{ red: ... ; green: ... ; yellow: ... ; blue: ... ; magenta: ... ; cyan: ... ; white: ... ; gray: ... ; grey: ... ; brightRed: ... ; brightGreen: ... ; brightYellow: ... ; brightBlue: ... ; brightMagenta: ... ; brightCyan: ... ; brightWhite: ... }>> ; reset: ZodOptional<ZodDefault<ZodBoolean>> }, $strip>> ; inputPrefix: ZodOptional<ZodDefault<ZodString>> ; outputPrefix: ZodOptional<ZodDefault<ZodString>> ; prefixStyle: ZodOptional<ZodObject<{ bold: ZodOptional<ZodBoolean> ; underline: ZodOptional<ZodBoolean> ; color: ZodOptional<ZodEnum<{ red: ... ; green: ... ; yellow: ... ; blue: ... ; magenta: ... ; cyan: ... ; white: ... ; gray: ... ; grey: ... ; brightRed: ... ; brightGreen: ... ; brightYellow: ... ; brightBlue: ... ; brightMagenta: ... ; brightCyan: ... ; brightWhite: ... }>> ; reset: ZodOptional<ZodDefault<ZodBoolean>> }, $strip>> ; compact: ZodOptional<ZodDefault<ZodBoolean>> }, $strip>> ; usageText: ZodOptional<ZodString> ; headerText: ZodOptional<ZodString> ; footerText: ZodOptional<ZodString> }, $strip>

Defined in

src/help.ts:35

src/help.ts:113

---

defaultHelpConfig

• Const defaultHelpConfig: DeepRequired<HelpConfig>

Defined in

src/help.ts:115