Parser.Parse(IReadOnlyList<String>, String) Method

Definition

Namespace:

System.CommandLine.Parsing

Assembly:

System.CommandLine.dll

Parses a list of arguments.

public System.CommandLine.Parsing.ParseResult Parse (System.Collections.Generic.IReadOnlyList<string> arguments, string? rawInput = default);

member this.Parse : System.Collections.Generic.IReadOnlyList<string> * string -> System.CommandLine.Parsing.ParseResult

Public Function Parse (arguments As IReadOnlyList(Of String), Optional rawInput As String = Nothing) As ParseResult

Parameters

arguments

IReadOnlyList<String>

The string array typically passed to a program's Main method.

rawInput

String

Holds the value of a complete command line input prior to splitting and tokenization, when provided. This will typically not be available when the parser is called from Program.Main. It's primarily used when calculating completions via the dotnet-suggest tool.

Returns

ParseResult

Details about the parse operation.