CommandLineParser Class

public class CommandLineParser

Public Class CommandLineParser

Dim instance As CommandLineParser

public ref class CommandLineParser

Inheritance

Object    CommandLineParser

Derived

Ookii.CommandLineCommandLineParserT

The CommandLineParser class parses command line arguments into named, strongly-typed values. The accepted arguments are defined by the properties and methods of the type passed to the CommandLineParser(Type, ParseOptions) constructor. The result of a parsing operation is an instance of that type, created using the values that were supplied on the command line.

The arguments type must have a constructor that has no parameters, or a single parameter with the type CommandLineParser, which will receive the instance of the CommandLineParser class that was used to parse the arguments.

A property defines a command line argument if it is public, not , and has the CommandLineArgumentAttribute attribute applied. The CommandLineArgumentAttribute attribute has properties to determine the behavior of the argument, such as whether it's required or positional.

A method defines a command line argument if it is public, , has the CommandLineArgumentAttribute attribute applied, and one of the signatures shown in the documentation for the CommandLineArgumentAttribute attribute.

To parse arguments, invoke the Parse method or one of its overloads, or use ParseWithErrorHandling or one of its overloads to automatically handle errors and print usage help when requested.

The static ParseT(ParseOptions) method is a helper that create a CommandLineParser instance, and parse arguments with error handling in a single call. If using source generation with the GeneratedParserAttribute attribute, you can also use the generated IParserTSelfParse(ParseOptions) method.

The derived type CommandLineParserT provides strongly-typed instance Parse and CommandLineParserTParseWithErrorHandling methods, if you don't wish to use the static methods.

The CommandLineParser class is for applications with a single (root) command. If you wish to create an application with subcommands, use the CommandManager class instead.

The CommandLineParser supports two sets of rules for how to parse arguments; ParsingModeDefault mode and ParsingModeLongShort mode. For more details on these rules, please see the documentation on GitHub.

Reference

Other Resources