HelpOptions
Options for customising help output.
- Import:
@kjanat/dreamcli - Export kind: interface
- Declared in:
src/core/help/index.ts - Source link:
src/core/help/index.ts:30
Signatures
interface HelpOptions {}Members
Properties
binName
Binary/program name shown in the usage line. Defaults to command name.
binName?: string;colors
Gated ANSI palette used to style help output. Identity formatters mean plain text. CLIBuilder.execute()/.run() thread the output channel's out.color here automatically, so styling follows the same policy as handler output (TTY + color support, no --json, NO_COLOR honored).
colors?: Colors;flagOrder
Order of flags in the Flags: table.
'alphabetical'— short-aliased flags first, then alphabetical by name.'declaration'— the order.flag()was called.
Ignored when HelpOptions.sortFlags is set.
flagOrder?: "alphabetical" | "declaration";footer
Show the Run '<bin> <command> --help' for more information. footer.
Defaults to showing the hint only when visible subcommands exist; set explicitly to force it on or off.
footer?: boolean;hyperlinks
Emit OSC 8 hyperlinks where link metadata is available (currently the root-help header name/version configured via CLIBuilder.links()). Defaults to false; CLIBuilder.execute()/.run() enable it automatically when stdout is a TTY.
hyperlinks?: boolean;inlineDefault
Render the default command's arguments and flags inline in root help.
Only affects root-level help. When false, root help lists commands and defers default-command details to <bin> --help-style hints.
inlineDefault?: boolean;isDefaultHelp
Whether this usage line is being rendered as merged root/default help.
isDefaultHelp?: boolean;showDefaultInCommands
List the default command in the root Commands: table.
By default the default command is treated as the root surface and omitted from the command list (its args/flags render inline instead).
showDefaultInCommands?: boolean;sortFlags
Custom comparator over flag long names for the Flags: table. When set, it wins over HelpOptions.flagOrder.
sortFlags?: { (a: string, b: string): number; };theme
Theme overrides merged over the built-in help theme. Receives the gated palette; never invoked when color is off, so overrides cannot leak escapes into piped output.
theme?: HelpThemeFactory;version
Program version passed to function-form examples as meta.version.
version?: string;width
Maximum line width (columns). Defaults to 80.
width?: number;