MyOddWeb.CommandlineParser 0.1.5

Requires NuGet 2.12 or higher.

dotnet add package MyOddWeb.CommandlineParser --version 0.1.5
NuGet\Install-Package MyOddWeb.CommandlineParser -Version 0.1.5
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="MyOddWeb.CommandlineParser" Version="0.1.5" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add MyOddWeb.CommandlineParser --version 0.1.5
#r "nuget: MyOddWeb.CommandlineParser, 0.1.5"
#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 MyOddWeb.CommandlineParser as a Cake Addin
#addin nuget:?package=MyOddWeb.CommandlineParser&version=0.1.5

// Install MyOddWeb.CommandlineParser as a Cake Tool
#tool nuget:?package=MyOddWeb.CommandlineParser&version=0.1.5

Myoddweb.CommandlineParser Release

A very simple c# command line arguments Parser

What it does

  • Very simple command line parser for c#
  • Simple to import/install
  • Simple to use
  • You can create optional parameters
  • You can create help output.

Installing

Nuget

NuGet Status NuGet Count

Package manager

Install-Package MyOddWeb.CommandlineParser

CLI
.NET

dotnet add package MyOddWeb.CommandlineParser

Packet

packet add MyOddWeb.CommandlineParser

Example

Lets say that we have a application that has command line options to install and run as a console

  using myoddweb.commandlineparser;

  private void Bar()
  {
    ...
    var arguments = new CommandlineParser(args, new CommandlineArgumentRules
      {
        new HelpCommandlineArgumentRule( new []{"help", "h"} ) },
        new OptionalCommandlineArgumentRule( "config",  "config.json" ) },
        new OptionalCommandlineArgumentRule( "install" ) },
        new OptionalCommandlineArgumentRule( "console" ) },
        new RequiredCommandlineArgumentRule( "name" )
      });
    ...
  }

We can then check if we are running as a console

  ...
  if (arguments.IsSet("console"))
  {
    InvokeActionInstall();
    return;
  }
  ...

We can also call the config value as we know it exists... (we have a default value)

  ...
  var config = _arguments["config"];
  ...

We can also get a default value directly

For example, in the example below, we will either get the number that was passed, (example.exe --a 32), or the default value.

The value itself will be an integer, as this is what we expect...

  ...
  var theGalaxy = parser.Get<int>("a", 42)
  ...

The argument does not have to have a value, for example you could have example.exe --a --b

In that case you would simply default

  ...
  var arguments = new CommandlineParser(args, null );
  ...

What if you want a different leading pattern ...? Something like example.exe -a -b

Simply pass it as a third argument ...

  ...
  var arguments = new CommandlineParser(args, null, "-" );
  ...
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 netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 is compatible.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net452 is compatible.  net46 was computed.  net461 was computed.  net462 is compatible.  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. 
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.
  • .NETCoreApp 3.0

    • No dependencies.
  • .NETFramework 4.5.2

    • No dependencies.
  • .NETFramework 4.6.2

    • No dependencies.
  • .NETStandard 2.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.1.5 679 1/27/2020
0.1.4 467 1/20/2020
0.1.3 772 4/14/2019
0.1.2 758 4/2/2019
0.1.1 714 4/1/2019
0.1.0 838 2/14/2019