Command Line Parser Library

De Banane Atomic
Aller à la navigationAller à la recherche

Documentation

Options

Csharp.svg
// créer une classe dont l'instance sera passée à la méthode ParseArguments
class Options
{
    [Usage(ApplicationAlias = "My Application")]
    public static IEnumerable<Example> Examples => new List<Example>()
    {
        new Example(
            "Description of the application",
            new Options { Option1 = "Option1", Option2 = 100 })
    };

    [Option('o', "option1", Required = true, HelpText = "Option1.")]
    public string Option1 { get; set; }

    [Option('t', "option2", HelpText = "Option2.")]
    public int Option2 { get; set; }
}

Parsing

Csharp.svg
static void Main(string[] args)
{
    Parser.Default.ParseArguments<Options>(args)
          .MapResult(
              options => RunAndReturnExitCode(options),
              _ => 1);

Parsing with async

Csharp.svg
static async Task Main(string[] args)
{
    await Parser.Default.ParseArguments<Options>(args)
                .MapResult(
                    async options => await RunAndReturnExitCodeAsync(options),
                    _ => Task.FromResult(1));

Command line

In case of missing or unknown argument or parsing error, the errors are displayed with the usage explanation message and the application exits.
By default options --help and --version are available.
Powershell.svg
# option1
-o value
-ovalue
--option1 value
--option1=value