Command Class

Definition

Namespace:: System.CommandLine

Assembly:: System.CommandLine.dll

Package:: System.CommandLine v2.0.0-beta6.25358.103

Source:: Command.cs

Source:: Command.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents a specific action that the application performs.

public ref class Command : System::CommandLine::Symbol, System::Collections::IEnumerable

public ref class Command : System::CommandLine::IdentifierSymbol, System::Collections::Generic::IEnumerable<System::CommandLine::Symbol ^>

public class Command : System.CommandLine.Symbol, System.Collections.IEnumerable

public class Command : System.CommandLine.IdentifierSymbol, System.Collections.Generic.IEnumerable<System.CommandLine.Symbol>

type Command = class
    inherit Symbol
    interface IEnumerable

type Command = class
    inherit IdentifierSymbol
    interface seq<Symbol>
    interface IEnumerable

Public Class Command
Inherits Symbol
Implements IEnumerable

Public Class Command
Inherits IdentifierSymbol
Implements IEnumerable(Of Symbol)

Inheritance: Object

Symbol
Command

Inheritance: Object

Symbol

IdentifierSymbol
Command

Derived: System.CommandLine.RootCommand

Implements: IEnumerable IEnumerable<Symbol>

Remarks

Use the Command object for actions that correspond to a specific string (the command name). See RootCommand for simple applications that only have one action. For example, dotnet run uses run as the command.

Constructors

Command(String, String)

Initializes a new instance of the Command class.

Properties

Action
Aliases
Aliases	Gets the set of strings that can be used on the command line to specify the symbol. (Inherited from IdentifierSymbol)
Arguments	Represents all of the arguments for the command.
Children	Gets the child symbols.
Description	Gets or sets the description of the symbol. (Inherited from Symbol)
Handler	Gets or sets the ICommandHandler for the command. The handler represents the action that will be performed when the command is invoked.
Hidden	(Inherited from Symbol)
IsHidden	Gets or sets a value indicating whether the symbol is hidden. (Inherited from Symbol)
Name	Gets or sets the name of the symbol. (Inherited from Symbol)
Name	Gets or sets the symbol name. (Inherited from IdentifierSymbol)
Options	Represents all of the options for the command, including global options that have been applied to any of the command's ancestors.
Parents	Gets the parent symbols. (Inherited from Symbol)
Subcommands	Represents all of the subcommands for the command.
TreatUnmatchedTokensAsErrors	Gets or sets a value that indicates whether unmatched tokens should be treated as errors. For example, if set to `true` and an extra command or argument is provided, validation will fail.
Validators

Methods

Add(Argument)	Adds an Argument to the command.
Add(Command)	Adds a subcommand to the command.
Add(Option)	Adds an Option to the command.
AddAlias(String)	Adds an alias. (Inherited from IdentifierSymbol)
AddArgument(Argument)	Adds an Argument to the command.
AddCommand(Command)	Adds a subcommand to the command.
AddGlobalOption(Option)	Adds a global Option to the command.
AddOption(Option)	Adds an Option to the command.
AddValidator(ValidateSymbolResult<CommandResult>)	Adds a custom validator to the command. Validators can be used to create custom validation logic.
GetCompletions()	Gets completions for the symbol. (Inherited from Symbol)
GetCompletions(CompletionContext)	Gets the suggested values for command line completion.
GetEnumerator()	Represents all of the symbols for the command.
HasAlias(String)	Determines whether the specified alias has already been defined. (Inherited from IdentifierSymbol)
Parse(IReadOnlyList<String>, CommandLineConfiguration)
Parse(String, CommandLineConfiguration)
SetAction(Action<ParseResult>)
SetAction(Func<ParseResult,CancellationToken,Task<Int32>>)
SetAction(Func<ParseResult,CancellationToken,Task>)
SetAction(Func<ParseResult,Int32>)
SetAction(Func<ParseResult,Task>)
ToString()	Returns a string that represents the current object. (Inherited from Symbol)

Explicit Interface Implementations

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

Extension Methods

Invoke(Command, String, IConsole)	Parses and invokes a command.
Invoke(Command, String[], IConsole)	Parses and invokes a command.
InvokeAsync(Command, String, IConsole)	Parses and invokes a command.
InvokeAsync(Command, String[], IConsole)	Parses and invokes a command.
Parse(Command, String)	Parses a command line string value using the specified command.
Parse(Command, String[])	Parses an array strings using the specified command.
ConfigureFromMethod(Command, MethodInfo, Object)
SetHandler(Command, Action)	Sets a command's handler based on an Action.
SetHandler(Command, Action<InvocationContext>)	Sets a command's handler based on an Action<T>.
SetHandler(Command, Func<InvocationContext,Task>)	Sets a command's handler based on a Func<T,TResult>.
SetHandler(Command, Func<Task>)	Sets a command's handler based on a Func<TResult>.
SetHandler<T>(Command, Action<T>, IValueDescriptor<T>)	Sets a command's handler based on an Action<T>.
SetHandler<T>(Command, Func<T,Task>, IValueDescriptor<T>)	Sets a command's handler based on a Func<T,TResult>.
SetHandler<T1,T2>(Command, Action<T1,T2>, IValueDescriptor<T1>, IValueDescriptor<T2>)	Sets a command's handler based on an Action<T1,T2>.
SetHandler<T1,T2>(Command, Func<T1,T2,Task>, IValueDescriptor<T1>, IValueDescriptor<T2>)	Sets a command's handler based on a Func<T1,T2,TResult>.
SetHandler<T1,T2,T3>(Command, Action<T1,T2,T3>, IValueDescriptor<T1>, IValueDescriptor<T2>, IValueDescriptor<T3>)	Sets a command's handler based on an Action<T1,T2,T3>.
SetHandler<T1,T2,T3>(Command, Func<T1,T2,T3,Task>, IValueDescriptor<T1>, IValueDescriptor<T2>, IValueDescriptor<T3>)	Sets a command's handler based on a Func<T1,T2,T3,TResult>.
SetHandler<T1,T2,T3,T4>(Command, Action<T1,T2,T3,T4>, IValueDescriptor<T1>, IValueDescriptor<T2>, IValueDescriptor<T3>, IValueDescriptor<T4>)	Sets a command's handler based on an Action<T1,T2,T3,T4>.
SetHandler<T1,T2,T3,T4>(Command, Func<T1,T2,T3,T4,Task>, IValueDescriptor<T1>, IValueDescriptor<T2>, IValueDescriptor<T3>, IValueDescriptor<T4>)	Sets a command's handler based on a Func<T1,T2,T3,T4,TResult>.
SetHandler<T1,T2,T3,T4,T5>(Command, Action<T1,T2,T3,T4,T5>, IValueDescriptor<T1>, IValueDescriptor<T2>, IValueDescriptor<T3>, IValueDescriptor<T4>, IValueDescriptor<T5>)	Sets a command's handler based on an Action<T1,T2,T3,T4,T5>.
SetHandler<T1,T2,T3,T4,T5>(Command, Func<T1,T2,T3,T4,T5,Task>, IValueDescriptor<T1>, IValueDescriptor<T2>, IValueDescriptor<T3>, IValueDescriptor<T4>, IValueDescriptor<T5>)	Sets a command's handler based on a Func<T1,T2,T3,T4,T5,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6>(Command, Action<T1,T2,T3,T4,T5, T6>, IValueDescriptor<T1>, IValueDescriptor<T2>, IValueDescriptor<T3>, IValueDescriptor<T4>, IValueDescriptor<T5>, IValueDescriptor<T6>)	Sets a command's handler based on an Action<T1,T2,T3,T4,T5,T6>.
SetHandler<T1,T2,T3,T4,T5,T6>(Command, Func<T1,T2,T3,T4,T5,T6, Task>, IValueDescriptor<T1>, IValueDescriptor<T2>, IValueDescriptor<T3>, IValueDescriptor<T4>, IValueDescriptor<T5>, IValueDescriptor<T6>)	Sets a command's handler based on a Func<T1,T2,T3,T4,T5,T6,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7>(Command, Action<T1,T2,T3,T4, T5,T6,T7>, IValueDescriptor<T1>, IValueDescriptor<T2>, IValueDescriptor<T3>, IValueDescriptor<T4>, IValueDescriptor<T5>, IValueDescriptor<T6>, IValueDescriptor<T7>)	Sets a command's handler based on an Action<T1,T2,T3,T4,T5,T6,T7>.
SetHandler<T1,T2,T3,T4,T5,T6,T7>(Command, Func<T1,T2,T3,T4,T5, T6,T7,Task>, IValueDescriptor<T1>, IValueDescriptor<T2>, IValueDescriptor<T3>, IValueDescriptor<T4>, IValueDescriptor<T5>, IValueDescriptor<T6>, IValueDescriptor<T7>)	Sets a command's handler based on a Func<T1,T2,T3,T4,T5,T6,T7,TResult>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8>(Command, Action<T1,T2,T3, T4,T5,T6,T7,T8>, IValueDescriptor<T1>, IValueDescriptor<T2>, IValueDescriptor<T3>, IValueDescriptor<T4>, IValueDescriptor<T5>, IValueDescriptor<T6>, IValueDescriptor<T7>, IValueDescriptor<T8>)	Sets a command's handler based on an Action<T1,T2,T3,T4,T5,T6,T7,T8>.
SetHandler<T1,T2,T3,T4,T5,T6,T7,T8>(Command, Func<T1,T2,T3,T4, T5,T6,T7,T8,Task>, IValueDescriptor<T1>, IValueDescriptor<T2>, IValueDescriptor<T3>, IValueDescriptor<T4>, IValueDescriptor<T5>, IValueDescriptor<T6>, IValueDescriptor<T7>, IValueDescriptor<T8>)	Sets a command's handler based on a Func<T1,T2,T3,T4,T5,T6,T7,T8,TResult>.
UseCommandHandler<THandler>(Command)

Applies to

Product	Versions
.NET	8 (package-provided), 9 (package-provided), 10 (package-provided)
.NET Standard	2.0 (package-provided)

Collaborate with us on GitHub

The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.

.NET feedback

.NET is an open source project. Select a link to provide feedback:

Open a documentation issue Provide product feedback

Microsoft Ignite

Share via

Command Class

Definition

Remarks

Constructors

Properties

Methods

Explicit Interface Implementations

Extension Methods

Applies to

Ask Learn

Share via

Command Class

Definition

Remarks

Constructors

Properties

Methods

Explicit Interface Implementations

Extension Methods

Applies to

Feedback