McMaster.Extensions.CommandLineUtils 2.2.2

Prefix Reserved

There is a newer version of this package available.
See the version list below for details.

dotnet add package McMaster.Extensions.CommandLineUtils --version 2.2.2

NuGet\Install-Package McMaster.Extensions.CommandLineUtils -Version 2.2.2

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<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.

#r "nuget: McMaster.Extensions.CommandLineUtils, 2.2.2"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

// Install McMaster.Extensions.CommandLineUtils as a Cake Addin
#addin nuget:?package=McMaster.Extensions.CommandLineUtils&version=2.2.2

// Install McMaster.Extensions.CommandLineUtils as a Cake Tool
#tool nuget:?package=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.

Product	Compatible and additional computed target framework versions.
.NET	net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed.
.NET Core	netcoreapp1.0 was computed. netcoreapp1.1 was computed. netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed.
.NET Standard	netstandard1.6 is compatible. netstandard2.0 is compatible. netstandard2.1 was computed.
.NET Framework	net45 is compatible. net451 was computed. net452 was computed. net46 was computed. net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed.
MonoAndroid	monoandroid was computed.
MonoMac	monomac was computed.
MonoTouch	monotouch was computed.
Tizen	tizen30 was computed. tizen40 was computed. tizen60 was computed.
Xamarin.iOS	xamarinios was computed.
Xamarin.Mac	xamarinmac was computed.
Xamarin.TVOS	xamarintvos was computed.
Xamarin.WatchOS	xamarinwatchos was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

.NETFramework 4.5
- System.ValueTuple (>= 4.4.0)
.NETStandard 1.6
- System.ComponentModel.Annotations (>= 4.1.0)
- System.Diagnostics.Process (>= 4.1.0)
- System.Threading.Thread (>= 4.0.0)
- System.ValueTuple (>= 4.4.0)
.NETStandard 2.0
- System.ComponentModel.Annotations (>= 4.4.1)

NuGet packages (82)

Showing the top 5 NuGet packages that depend on McMaster.Extensions.CommandLineUtils:

Package	Downloads
McMaster.Extensions.Hosting.CommandLine Provides command-line parsing API integration with the generic host API (Microsoft.Extensions.Hosting).	1.7M
QuantConnect.Configuration QuantConnect LEAN Engine: Configuration Project - The Config and argument parser implementation	1.3M
FlubuCore A cross platform build and deployment automation system for building projects and executing deployment scripts using C# code. Documentation can be found at: https://github.com/dotnetcore/FlubuCore Detailed examples can be found at: https://github.com/dotnetcore/FlubuCore.Examples	514.0K
KubeOps This is an operator sdk written in c#. It enables a developer to create a custom controller for CRDs (CustomResourceDefinitions) that runs on kubernetes.	281.1K
Faithlife.Build A build automation system using C# build scripts.	222.5K

GitHub repositories (107)

Showing the top 5 popular GitHub repositories that depend on McMaster.Extensions.CommandLineUtils:

Repository	Stars
icsharpcode/ILSpy .NET Decompiler with support for PDB generation, ReadyToRun, Metadata (&more) - cross-platform!	21.7K
QuantConnect/Lean Lean Algorithmic Trading Engine by QuantConnect (Python, C#)	10.0K
ChilliCream/graphql-platform Welcome to the home of the Hot Chocolate GraphQL server for .NET, the Strawberry Shake GraphQL client for .NET and Banana Cake Pop the awesome Monaco based GraphQL IDE.	5.3K
xunit/xunit xUnit.net is a free, open source, community-focused unit testing tool for .NET.	4.2K
cobbr/Covenant Covenant is a collaborative .NET C2 framework for red teamers.	4.2K

Version	Downloads	Last updated
4.1.1	1,111,478	2/19/2024
4.1.0	722,119	8/26/2023
4.0.2	1,628,478	11/19/2022
4.0.1	2,144,868	2/1/2022
4.0.0	662,098	12/27/2021
4.0.0-beta.74	49,168	1/22/2021
4.0.0-beta.56	1,216	1/17/2021
3.1.0	2,968,351	1/10/2021
3.1.0-rc.371	5,631	11/7/2020
3.1.0-beta.356	1,364	9/13/2020
3.1.0-beta.336	569	8/28/2020
3.0.0	2,723,214	3/29/2020
3.0.0-rc.289	4,957	3/21/2020
3.0.0-alpha.268	2,479	3/9/2020
2.6.0	735,264	3/8/2020
2.5.1	242,172	2/7/2020
2.5.0	255,635	1/2/2020
2.4.4	206,196	11/11/2019
2.4.3	28,661	11/1/2019
2.4.2	186,265	9/24/2019
2.4.1	21,147	9/18/2019
2.4.0	18,043	9/14/2019
2.3.4	1,009,940	4/11/2019
2.3.3	206,301	3/11/2019
2.3.2	315,732	2/5/2019
2.3.1	44,228	1/19/2019
2.3.0	267,938	1/1/2019
2.2.5	1,438,628	7/2/2018
2.2.4	292,557	5/25/2018
2.2.3	31,888	5/11/2018
2.2.2	94,841	4/28/2018
2.2.1	107,860	4/11/2018
2.2.0	579,725	3/31/2018
2.2.0-rc	8,273	3/23/2018
2.2.0-beta	3,181	3/8/2018
2.2.0-alpha	3,134	2/20/2018
2.1.1	130,022	12/28/2017
2.1.0	13,754	12/13/2017
2.1.0-rc	3,057	12/7/2017
2.1.0-beta	4,017	11/22/2017
2.1.0-alpha	2,875	11/11/2017
2.0.1	17,628	10/13/2017
2.0.0	18,246	9/16/2017

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

McMaster.Extensions.CommandLineUtils 2.2.2

Attribute API

Builder API

Utilities

.NETFramework 4.5

.NETStandard 1.6

.NETStandard 2.0

NuGet packages (82)

GitHub repositories (107)