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:25
Signatures
ts
interface HelpOptions {}Members
Properties
binName
Binary/program name shown in the usage line. Defaults to command name.
ts
binName?: string;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.
ts
hyperlinks?: boolean;isDefaultHelp
Whether this usage line is being rendered as merged root/default help.
ts
isDefaultHelp?: boolean;width
Maximum line width (columns). Defaults to 80.
ts
width?: number;