BinaryPatrick.ArgumentHelper 0.9.0

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. 
dotnet add package BinaryPatrick.ArgumentHelper --version 0.9.0
                    


                    

                
NuGet\Install-Package BinaryPatrick.ArgumentHelper -Version 0.9.0
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="BinaryPatrick.ArgumentHelper" Version="0.9.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="BinaryPatrick.ArgumentHelper" Version="0.9.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="BinaryPatrick.ArgumentHelper" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add BinaryPatrick.ArgumentHelper --version 0.9.0
                    


                    

                
#r "nuget: BinaryPatrick.ArgumentHelper, 0.9.0"
#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. 
#:package BinaryPatrick.ArgumentHelper@0.9.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=BinaryPatrick.ArgumentHelper&version=0.9.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=BinaryPatrick.ArgumentHelper&version=0.9.0
                    


                            Install as a Cake Tool

Argument Helper

This is a command line argument parser that is lightweight and easy to use. It allows the use of attributes to define command line arguments, and the enable conversion into a given type.

Quickstart

public class AppArguments
{
    [RequiredArgument("directory", "This represents a required string value", 0)]
    public string Directory { get; set; }

    [OptionalArgument("extension", "This represents an optional argument", ShortFlag = "e")]
    public string? FileExtension { get; set; }
}

public class Program {
    public void Main(string[] args) {
        ArgumentParser<AppArguments> parser = ArgumentParser.Initialize<AppArguments>();
        AppArguments aa = parser.Parse(args);
    }
}

It has been tested to work with primatives and enums. It also produces a nicely formatted help output when it detects an error and includes logging.

Automatically Generated Help

You can add custom help flags by using:

IArgumentParser<T>.SetHelpFlags(fullFlag, shortFlag)

You can also add a descriptions using:

IArgumentParser<T>.AddDescription(text)`

Example of automatically generated help message

Usage: YourApp DIRECTORY [OPTIONS]

Arguments:
    DIRECTORY This represents a required string value [required]

Options:
    --extension, -e         This represents an optional argument
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  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 is compatible.  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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

  • net6.0

    • No dependencies.

  • net7.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.9.0 320 6/22/2023