Spectre.Console

ICommandConfigurator

Represents a command configurator.

Represents a command configurator.

Methods

public ICommandConfigurator IsHidden()

Marks the command as hidden. Hidden commands do not show up in help documentation or generated XML models.

Returns:

The same ICommandConfigurator instance so that multiple calls can be chained.

public ICommandConfigurator WithAlias(string name)

Adds an alias (an alternative name) to the command being configured.

Parameters:

name (string)
The alias to add to the command being configured.

Returns:

The same ICommandConfigurator instance so that multiple calls can be chained.

public ICommandConfigurator WithData(object data)

Sets data that will be passed to the command via the CommandContext.

Parameters:

data (object)
The data to pass to the command.

Returns:

The same ICommandConfigurator instance so that multiple calls can be chained.

public ICommandConfigurator WithDescription(string description)

Sets the description of the command.

Parameters:

description (string)
The command description.

Returns:

The same ICommandConfigurator instance so that multiple calls can be chained.

public ICommandConfigurator WithExample(string[] args)

Adds an example of how to use the command.

Parameters:

args (string[])
The example arguments.

Returns:

The same ICommandConfigurator instance so that multiple calls can be chained.