McMaster.Extensions.CommandLineUtils
2.2.1
Prefix Reserved
See the version list below for details.
dotnet add package McMaster.Extensions.CommandLineUtils --version 2.2.1
NuGet\Install-Package McMaster.Extensions.CommandLineUtils -Version 2.2.1
<PackageReference Include="McMaster.Extensions.CommandLineUtils" Version="2.2.1" />
paket add McMaster.Extensions.CommandLineUtils --version 2.2.1
#r "nuget: McMaster.Extensions.CommandLineUtils, 2.2.1"
// Install McMaster.Extensions.CommandLineUtils as a Cake Addin #addin nuget:?package=McMaster.Extensions.CommandLineUtils&version=2.2.1 // Install McMaster.Extensions.CommandLineUtils as a Cake Tool #tool nuget:?package=McMaster.Extensions.CommandLineUtils&version=2.2.1
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;
[HelpOption]
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 processProcess.Start(DotNetExe.FullPathOrDefault(), "run");
And more! See the docs for more API, such as IConsole
, IReporter
, and others.
Product | Versions 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. |
-
.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). |
|
QuantConnect.Configuration
QuantConnect LEAN Engine: Configuration Project - The Config and argument parser implementation |
|
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 |
|
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. |
|
Faithlife.Build
A build automation system using C# build scripts. |
GitHub repositories (108)
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!
|
|
QuantConnect/Lean
Lean Algorithmic Trading Engine by QuantConnect (Python, C#)
|
|
ChilliCream/graphql-platform
Welcome to the home of the Hot Chocolate GraphQL server for .NET, the Strawberry Shake GraphQL client for .NET and Nitro the awesome Monaco based GraphQL IDE.
|
|
xunit/xunit
xUnit.net is a free, open source, community-focused unit testing tool for .NET.
|
|
cobbr/Covenant
Covenant is a collaborative .NET C2 framework for red teamers.
|
Version | Downloads | Last updated | |
---|---|---|---|
4.1.1 | 1,272,507 | 2/19/2024 | |
4.1.0 | 734,576 | 8/26/2023 | |
4.0.2 | 1,657,626 | 11/19/2022 | |
4.0.1 | 2,166,442 | 2/1/2022 | |
4.0.0 | 666,926 | 12/27/2021 | |
4.0.0-beta.74 | 49,517 | 1/22/2021 | |
4.0.0-beta.56 | 1,218 | 1/17/2021 | |
3.1.0 | 3,018,734 | 1/10/2021 | |
3.1.0-rc.371 | 5,670 | 11/7/2020 | |
3.1.0-beta.356 | 1,368 | 9/13/2020 | |
3.1.0-beta.336 | 572 | 8/28/2020 | |
3.0.0 | 2,758,960 | 3/29/2020 | |
3.0.0-rc.289 | 4,961 | 3/21/2020 | |
3.0.0-alpha.268 | 2,482 | 3/9/2020 | |
2.6.0 | 743,467 | 3/8/2020 | |
2.5.1 | 243,347 | 2/7/2020 | |
2.5.0 | 258,271 | 1/2/2020 | |
2.4.4 | 207,572 | 11/11/2019 | |
2.4.3 | 28,841 | 11/1/2019 | |
2.4.2 | 187,880 | 9/24/2019 | |
2.4.1 | 21,448 | 9/18/2019 | |
2.4.0 | 18,226 | 9/14/2019 | |
2.3.4 | 1,012,541 | 4/11/2019 | |
2.3.3 | 207,841 | 3/11/2019 | |
2.3.2 | 316,904 | 2/5/2019 | |
2.3.1 | 44,429 | 1/19/2019 | |
2.3.0 | 270,101 | 1/1/2019 | |
2.2.5 | 1,459,468 | 7/2/2018 | |
2.2.4 | 298,561 | 5/25/2018 | |
2.2.3 | 32,157 | 5/11/2018 | |
2.2.2 | 95,530 | 4/28/2018 | |
2.2.1 | 108,416 | 4/11/2018 | |
2.2.0 | 595,679 | 3/31/2018 | |
2.2.0-rc | 8,282 | 3/23/2018 | |
2.2.0-beta | 3,190 | 3/8/2018 | |
2.2.0-alpha | 3,145 | 2/20/2018 | |
2.1.1 | 130,572 | 12/28/2017 | |
2.1.0 | 13,949 | 12/13/2017 | |
2.1.0-rc | 3,066 | 12/7/2017 | |
2.1.0-beta | 4,028 | 11/22/2017 | |
2.1.0-alpha | 2,885 | 11/11/2017 | |
2.0.1 | 17,794 | 10/13/2017 | |
2.0.0 | 18,883 | 9/16/2017 |
Bug fixes:
- Don't assign option and argument options if no value was provided, preserving the default CLR value unless there is user-input.
- Fix ShowHint() to use ShortName or SymbolName if OptionHelp.LongName is not set
- Fix #85 - lower priority of resolving AdditionalServices after most built-in services
- Fix #79 - OnValidate callbacks invoked before property valueswere assigned
Minor improvements:
- Improve help text generation. Align columns, show top-level command description, and add `protected virtual` API to `DefaultHelpTextGenerator` to make it easier to customize help text
See more details here: https://github.com/natemcmaster/CommandLineUtils/blob/master/CHANGELOG.md#v221