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 can parse a set of command line arguments into values. Which arguments are accepted is determined from the constructor parameters, 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.

An argument defined by a constructor parameter is always positional, and is required if the parameter has no default value. If your type has multiple constructors, use the CommandLineConstructorAttribute attribute to indicate which one to use.

A constructor parameter with the type CommandLineParser is not an argument, but will be passed the instance of the CommandLineParser class used to parse the arguments when the type is instantiated.

A property defines a command line argument if it is public, not , and has the CommandLineArgumentAttribute attribute defined. The properties of the argument are determined by the properties of the CommandLineArgumentAttribute class.

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. The static ParseT(ParseOptions) method is a helper that will parse arguments and print error and usage information if required. Calling this method will be sufficient for most use cases.

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

The CommandLineParser class can generate detailed usage help for the defined arguments, which can be shown to the user to provide information about how to invoke your application from the command line. This usage is shown automatically by the ParseT(ParseOptions) method and the CommandManager class, or you can use the WriteUsage(UsageWriter) and GetUsage(UsageWriter, Int32) methods to generate it manually.

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; Default mode and LongShort mode. For more details on these rules, please see the documentation on GitHub.

Reference

Other Resources