McMaster.Extensions.CommandLineUtils 2.2.2

Command-line parsing API. A community-maintained fork of Microsoft.Extensions.CommandLineUtils, plus extras.
Commonly used types:

McMaster.Extensions.CommandLineUtils.CommandLineApplication
McMaster.Extensions.CommandLineUtils.CommandOption
McMaster.Extensions.CommandLineUtils.IConsole
McMaster.Extensions.CommandLineUtils.ArgumentEscaper

There is a newer version of this package available.
See the version list below for details.
Install-Package McMaster.Extensions.CommandLineUtils -Version 2.2.2
dotnet add package McMaster.Extensions.CommandLineUtils --version 2.2.2
<PackageReference Include="McMaster.Extensions.CommandLineUtils" Version="2.2.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add McMaster.Extensions.CommandLineUtils --version 2.2.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

CommandLineApplication is the main entry point for most console apps parsing. There are two primary ways to use this API, using the builder pattern and attributes.

Attribute API

using System;
using McMaster.Extensions.CommandLineUtils;

public class Program
{
    public static int Main(string[] args)
        => CommandLineApplication.Execute<Program>(args);

    [Option(Description = "The subject")]
    public string Subject { get; }

    private void OnExecute()
    {
        var subject = Subject ?? "world";
        Console.WriteLine($"Hello {subject}!");
    }
}

Builder API

using System;
using McMaster.Extensions.CommandLineUtils;

public class Program
{
    public static int Main(string[] args)
    {
        var app = new CommandLineApplication();

        app.HelpOption();
        var optionSubject = app.Option("-s|--subject <SUBJECT>", "The subject", CommandOptionType.SingleValue);

        app.OnExecute(() =>
        {
            var subject = optionSubject.HasValue()
                ? optionSubject.Value()
                : "world";

            Console.WriteLine($"Hello {subject}!");
            return 0;
        });

        return app.Execute(args);
    }
}

Utilities

The library also includes other utilities for interaction with the console. These include:

  • ArgumentEscaper - use to escape arguments when starting a new command line process.
     var args = new [] { "Arg1", "arg with space", "args ' with \"" quotes" };
     Process.Start("echo", ArgumentEscaper.EscapeAndConcatenate(args));
    
  • Prompt - for getting feedback from users. A few examples:
    // allows y/n responses
    Prompt.GetYesNo("Do you want to proceed?");
    
    // masks input as '*'
    Prompt.GetPassword("Password: ");
    
  • DotNetExe - finds the path to the dotnet.exe file used to start a .NET Core process
    Process.Start(DotNetExe.FullPathOrDefault(), "run");
    

And more! See the docs for more API, such as IConsole, IReporter, and others.

CommandLineApplication is the main entry point for most console apps parsing. There are two primary ways to use this API, using the builder pattern and attributes.

Attribute API

using System;
using McMaster.Extensions.CommandLineUtils;

public class Program
{
    public static int Main(string[] args)
        => CommandLineApplication.Execute<Program>(args);

    [Option(Description = "The subject")]
    public string Subject { get; }

    private void OnExecute()
    {
        var subject = Subject ?? "world";
        Console.WriteLine($"Hello {subject}!");
    }
}

Builder API

using System;
using McMaster.Extensions.CommandLineUtils;

public class Program
{
    public static int Main(string[] args)
    {
        var app = new CommandLineApplication();

        app.HelpOption();
        var optionSubject = app.Option("-s|--subject <SUBJECT>", "The subject", CommandOptionType.SingleValue);

        app.OnExecute(() =>
        {
            var subject = optionSubject.HasValue()
                ? optionSubject.Value()
                : "world";

            Console.WriteLine($"Hello {subject}!");
            return 0;
        });

        return app.Execute(args);
    }
}

Utilities

The library also includes other utilities for interaction with the console. These include:

  • ArgumentEscaper - use to escape arguments when starting a new command line process.
     var args = new [] { "Arg1", "arg with space", "args ' with \"" quotes" };
     Process.Start("echo", ArgumentEscaper.EscapeAndConcatenate(args));
    
  • Prompt - for getting feedback from users. A few examples:
    // allows y/n responses
    Prompt.GetYesNo("Do you want to proceed?");
    
    // masks input as '*'
    Prompt.GetPassword("Password: ");
    
  • DotNetExe - finds the path to the dotnet.exe file used to start a .NET Core process
    Process.Start(DotNetExe.FullPathOrDefault(), "run");
    

And more! See the docs for more API, such as IConsole, IReporter, and others.

Release Notes

Minor improvement:

- Add conventions from attributes that implement IConvention and IMemberConvention
- Add a help option by default as long as it doesn't conflict with existing options

See more details here: https://github.com/natemcmaster/CommandLineUtils/blob/master/CHANGELOG.md#v222

Version History

Version Downloads Last updated
2.4.0-alpha.70 85 6/20/2019
2.3.4 41,663 4/11/2019
2.3.3 30,356 3/11/2019
2.3.2 49,870 2/5/2019
2.3.1 13,046 1/19/2019
2.3.0 41,727 1/1/2019
2.3.0-rc.460 253 12/15/2018
2.3.0-beta 715 12/4/2018
2.3.0-alpha 1,881 10/3/2018
2.2.5 198,964 7/2/2018
2.2.4 36,911 5/25/2018
2.2.3 18,221 5/11/2018
2.2.2 16,558 4/28/2018
2.2.1 9,272 4/11/2018
2.2.0 99,438 3/31/2018
2.2.0-rc 802 3/23/2018
2.2.0-beta 538 3/8/2018
2.2.0-alpha 510 2/20/2018
2.1.1 49,664 12/28/2017
2.1.0 1,742 12/13/2017
2.1.0-rc 489 12/7/2017
2.1.0-beta 1,373 11/22/2017
2.1.0-alpha 393 11/11/2017
2.0.1 5,665 10/13/2017
2.0.0 4,124 9/16/2017
Show less