CliSettings Class

Represents the settings used by the Cli.

Definition

Namespace: DotMake.CommandLine
Assembly: DotMake.CommandLine (in DotMake.CommandLine.dll) Version: 1.8.8
C#
public class CliSettings
Inheritance
Object    CliSettings

Constructors

CliSettingsInitializes a new instance of the CliSettings class

Properties

EnableDefaultExceptionHandler Enables a default exception handler to catch any unhandled exceptions thrown during invocation. Default exception handler prints the exception in red color to console.

Default is .

EnableDiagramDirective Enables the use of the [diagram] directive, which when specified on the command line will short circuit normal command handling and display a diagram explaining the parse result for the command line input.

Default is .

EnableEnvironmentVariablesDirective Enables the use of the [env:key=value] directive, allowing environment variables to be set from the command line during invocation.

Default is .

EnablePosixBundling Enables the parser to recognize and expand POSIX-style bundled options.

Default is .

EnableSuggestDirective Enables the use of the [suggest] directive which when specified in command line input short circuits normal command handling and writes a newline-delimited list of suggestions suitable for use by most shells to provide command line completions.

Default is .

Error Gets or sets the standard error. Used for printing error information like parse errors.

Default is which means Error, will be used.

For testing purposes, it can be set to a new instance of StringWriter. If you want to disable the output, please set it to Null.
Output Gets or sets the standard output. Used by Help and other facilities that write non-error information.

Default is which means Out with encoding set to UTF8, will be used.

For testing purposes, it can be set to a new instance of StringWriter. If you want to disable the output, please set it to Null.
ProcessTerminationTimeout Enables signaling and handling of process termination (Ctrl+C, SIGINT, SIGTERM) via a CancellationToken that can be passed to a CliAction during invocation. If not provided, a default timeout of 2 seconds is enforced.
ResponseFileTokenReplacer Gets or sets the response file token replacer, enabled by default. To disable response files support, this property needs to be set to null.
Theme Gets or sets the theme used by the Cli. These color and formatting option are mainly used by the help output.

Default is Default.

See Also