NeoAgi.CommandLine 1.1.4

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package NeoAgi.CommandLine --version 1.1.4
                    


                    

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


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="NeoAgi.CommandLine" />
                    


                            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 NeoAgi.CommandLine --version 1.1.4
                    


                    

                
#r "nuget: NeoAgi.CommandLine, 1.1.4"
#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 NeoAgi.CommandLine@1.1.4
#: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=NeoAgi.CommandLine&version=1.1.4
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=NeoAgi.CommandLine&version=1.1.4
                    


                            Install as a Cake Tool

NeoAgi.CommandLine

Emulation of CommandLineParser intending to work more at home in a GenericHost World

Default Behvior

The following is all that is necessary to parse options or throw a usage diagram:

using NeoAgi.CommandLine;

try {
    T opts = args.GetOps<T>();
} 
catch(Exception) 
{
    // Handle failures
}

T can be any type with a constructor. Any property decorated with (OptionAttribute)[OptionAttribute.cs] will be parsed according to the following semantics:

  • Loop through all strings in args[]
  • If the string begins with - use the next ordnal as the value
  • Properties marked as Required must have a value present
  • Optional values can be defaulted by setting the default initializer on the Property (e.g. public int MaxAge { get; set; } = 99;)

See OptionManager.Parse(string[] arr) for further information.

GetOps.cs will raise Exceptions if help is requested (e.g. --help is the first argument) or if an Option cannot be parsed according to the constraints provided.

Help

To display the help without parsing args, provide --help as the first parameter.

Overriding Default Behaivor

If desired the entire exit process can be intercepted with a lambda of type Func<OptionManager, bool> on string[].GetOpt().

ProgramArguments opts = args.GetOps<ProgramArguments>((manager, exit) => {
    manager.PrintHelpErrors(Console.Error, manager.Errors);
    manager.PrintHelpOptions<ProgramArguments>(Console.Out);

    return false;  // Returning false will suppress the default print handler
});

This may be used to intercept the OptionManager just after errors have been set but before invoking the default print template allowing errors to be adjusted, inspected, or removed. All default template components are availabile if redirection to different streams is desired.

OptionManager.PrintHelp<T> describes the default usage used.

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

NuGet packages (1)

Showing the top 1 NuGet packages that depend on NeoAgi.CommandLine:

Package Downloads
NeoAgi.CommandLine.Extensions.Configuration

NeoAgi.CommandLine Configuration Provider for Generic NETCORE Hosts

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
9.0.0 346 11/5/2025
1.5.0 338 10/9/2023
1.4.1 579 11/29/2021
1.4.0 550 11/13/2021
1.3.1 546 10/20/2021
1.3.0 566 10/20/2021
1.2.0 587 10/17/2021
1.1.4 533 10/4/2021
1.1.3 524 10/4/2021
1.1.2 518 10/4/2021
1.1.1 521 10/3/2021
1.1.0 541 10/3/2021
1.0.2 623 10/2/2021