McMaster.Extensions.CommandLineUtils
4.1.1
Prefix Reserved
dotnet add package McMaster.Extensions.CommandLineUtils --version 4.1.1
NuGet\Install-Package McMaster.Extensions.CommandLineUtils -Version 4.1.1
<PackageReference Include="McMaster.Extensions.CommandLineUtils" Version="4.1.1" />
paket add McMaster.Extensions.CommandLineUtils --version 4.1.1
#r "nuget: McMaster.Extensions.CommandLineUtils, 4.1.1"
// Install McMaster.Extensions.CommandLineUtils as a Cake Addin #addin nuget:?package=McMaster.Extensions.CommandLineUtils&version=4.1.1 // Install McMaster.Extensions.CommandLineUtils as a Cake Tool #tool nuget:?package=McMaster.Extensions.CommandLineUtils&version=4.1.1
CommandLineUtils
This project helps you create command line applications using .NET. It simplifies parsing arguments provided on the command line, validating user inputs, and generating help text.
The roadmap for this project is pinned to the top of the issue list.
Usage
See documentation for API reference, samples, and tutorials. See also docs/samples/ for more examples, such as:
- Hello world
- Async console apps
- Structuring an app with subcommands
- Defining options with attributes
- Interactive console prompts
- Required options and arguments
Installing the library
This project is available as a NuGet package.
$ dotnet add package McMaster.Extensions.CommandLineUtils
Code
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; } = "world";
[Option(ShortName = "n")]
public int Count { get; } = 1;
private void OnExecute()
{
for (var i = 0; i < Count; i++)
{
Console.WriteLine($"Hello {Subject}!");
}
}
}
Builder API
using System;
using McMaster.Extensions.CommandLineUtils;
var app = new CommandLineApplication();
app.HelpOption();
var subject = app.Option("-s|--subject <SUBJECT>", "The subject", CommandOptionType.SingleValue);
subject.DefaultValue = "world";
var repeat = app.Option<int>("-n|--count <N>", "Repeat", CommandOptionType.SingleValue);
repeat.DefaultValue = 1;
app.OnExecute(() =>
{
for (var i = 0; i < repeat.ParsedValue; i++)
{
Console.WriteLine($"Hello {subject.Value()}!");
}
});
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 with a default answer. A few examples:// allows y/n responses, will return false by default in this case. // You may optionally change the prompt foreground and background color for // the message. Prompt.GetYesNo("Do you want to proceed?", false); // 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 documentation for more API, such as IConsole
, IReporter
, and others.
Getting help
If you need help with this project, please ...
- read the documentation (https://natemcmaster.github.io/CommandLineUtils/),
- look at the samples (https://github.com/natemcmaster/CommandLineUtils/tree/main/docs/samples),
- review existing questions (many were answered already) (https://github.com/natemcmaster/CommandLineUtils/issues?q=label%3Aquestion+),
- or use a programming Q&A forum such as StackOverflow.com
Project origin and status
This is a fork of Microsoft.Extensions.CommandLineUtils, which was completely abandoned by Microsoft. This project forked in 2017 and continued to make improvements. From 2017 to 2021, over 30 contributors added new features and fixed bugs. As of 2022, the project has entered maintenance mode, so no major changes are planned. See this issue for details on latest project status. This project is not abandoned -- I believe this library provides a stable API and rich feature set good enough for most developers to create command line apps in .NET -- but only the most critical of bugs will be fixed (such as security issues).
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 | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 is compatible. |
.NET Framework | net46 is compatible. 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 | 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.6
- System.Runtime.InteropServices.RuntimeInformation (>= 4.3.0)
- System.ValueTuple (>= 4.5.0)
-
.NETStandard 2.0
- System.ComponentModel.Annotations (>= 5.0.0)
-
.NETStandard 2.1
- System.ComponentModel.Annotations (>= 5.0.0)
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,270,790 | 2/19/2024 | |
4.1.0 | 734,540 | 8/26/2023 | |
4.0.2 | 1,657,571 | 11/19/2022 | |
4.0.1 | 2,166,362 | 2/1/2022 | |
4.0.0 | 666,911 | 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,564 | 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,739 | 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,434 | 3/8/2020 | |
2.5.1 | 243,336 | 2/7/2020 | |
2.5.0 | 258,241 | 1/2/2020 | |
2.4.4 | 207,554 | 11/11/2019 | |
2.4.3 | 28,830 | 11/1/2019 | |
2.4.2 | 187,858 | 9/24/2019 | |
2.4.1 | 21,435 | 9/18/2019 | |
2.4.0 | 18,215 | 9/14/2019 | |
2.3.4 | 1,012,518 | 4/11/2019 | |
2.3.3 | 207,828 | 3/11/2019 | |
2.3.2 | 316,881 | 2/5/2019 | |
2.3.1 | 44,416 | 1/19/2019 | |
2.3.0 | 270,081 | 1/1/2019 | |
2.2.5 | 1,459,108 | 7/2/2018 | |
2.2.4 | 298,548 | 5/25/2018 | |
2.2.3 | 32,146 | 5/11/2018 | |
2.2.2 | 95,519 | 4/28/2018 | |
2.2.1 | 108,402 | 4/11/2018 | |
2.2.0 | 595,421 | 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,560 | 12/28/2017 | |
2.1.0 | 13,936 | 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,781 | 10/13/2017 | |
2.0.0 | 18,867 | 9/16/2017 |
Changes since 4.0:
* Drop support for .NET < 4.6.
* fix: find dotnet.exe correctly when DOTNET_ROOT is not set (@danmoseley)
* fix: don't set DefaultValue to empty string for `string[]` options (@natemcmaster)
See more details here: https://github.com/natemcmaster/CommandLineUtils/blob/main/CHANGELOG.md#v411