Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

System.CommandLine Namespace

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.

Provides types for defining commands, options, arguments, and their relationships in command-line applications.

Classes

Name Description
Argument

A symbol defining a value that can be passed on the command line to a command or option.
Argument<T>

A symbol defining a value that can be passed on the command line to a command or option.
ArgumentValidation

Provides extension methods for Argument.
Command

Represents a specific action that the application performs.
CompletionSourceExtensions

Provides extension methods for working with completion sources.
DiagramDirective

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.
Directive

Provides cross-cutting functionality that can apply across command-line apps.
EnvironmentVariablesDirective

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

A symbol defining a named parameter and a value for that parameter.
Option<T>

A symbol defining a named parameter and a value for that parameter.
OptionValidation

Provides extension methods for Option.
ParserConfiguration

Represents the configuration used by the CommandLineParser.
ParseResult

Describes the results of parsing a command line input based on a specific parser configuration.
RootCommand

Represents the main action that the application performs.
Symbol

Defines a named symbol that resides in a hierarchy with parent and child symbols.
VersionOption

Represents a standard option that indicates that version information should be displayed for the app.

Structs

Name Description
ArgumentArity

Defines the arity of an option or argument.

Feedback

Was this page helpful?