DotMake Command-Line Documentation
CliParseTDefinition(String, Cli
Parses a command line string and returns the parse result for the indicated command.
Definition
Namespace: DotMake.CommandLine
Assembly: DotMake.CommandLine (in DotMake.CommandLine.dll) Version: 2.8.2
A CliResult providing details about the parse operation and methods for binding.
Assembly: DotMake.CommandLine (in DotMake.CommandLine.dll) Version: 2.8.2
C#
public static CliResult Parse<TDefinition>(
string commandLine,
CliSettings settings = null
)
Parameters
- commandLine String
- The command line string that will be split into tokens as if it had been passed on the command line. Useful for testing command line input by just specifying it as a single string.
- settings CliSettings (Optional)
- The settings for the parser's grammar and behaviors.
Type Parameters
- TDefinition
- The definition class for the command. A command builder for this class should be automatically generated by the source generator.
Return Value
CliResultA CliResult providing details about the parse operation and methods for binding.
Example
C#
//If you need to examine the parse result, such as errors:
var result = Cli.Parse<RootCliCommand>("NewValueForArgument1 --option-1 NewValueForOption1");
if (result.ParseResult.Errors.Count > 0)
{
}