Sharpify.CommandLineInterface 2.0.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package Sharpify.CommandLineInterface --version 2.0.0
                    


                    

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


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Sharpify.CommandLineInterface" />
                    


                            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 Sharpify.CommandLineInterface --version 2.0.0
                    


                    

                
#r "nuget: Sharpify.CommandLineInterface, 2.0.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 Sharpify.CommandLineInterface@2.0.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=Sharpify.CommandLineInterface&version=2.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Sharpify.CommandLineInterface&version=2.0.0
                    


                            Install as a Cake Tool

CHANGELOG

Version 2.0.0

WARNING: This release may contain breaking changes.

  • The Arguments source collection has been rewritten as a ReadOnlyCollection<string>, which cascaded into numerous changes:
    • Parser.ParseArguments (collection-based overloads) now takes a generic IList<string>. This is converted internally to a ReadOnlyCollection<string>, which is used as the source for Arguments.
    • As a result, Parser.Split now returns a List<string>.
    • The Parser.SplitToList method was removed, as it is no longer needed.
    • Arguments.ArgsAsMemory and Arguments.ArgsAsSpan were also removed. To inspect the source, use Arguments.Source or obtain a copy as a string[] with Arguments.SourceCopy.
    • The CliRunner.RunAsync overload that previously accepted a ReadOnlySpan<string> now accepts an IList<string> instead. This allows implicit casting from both string[] and List<string>, which are the most common CLI inputs.
  • HelpText generators now use a StringBuilder internally, replacing the previous custom buffer. Since help text generation typically occurs only once during a CLI's lifetime, any potential performance impact is minimal. This also removes some logical size restraints.
  • Removed Microsoft.SourceLink.Github as it is now used implicitly.

These changes enable several improvements:

  • Sharpify is no longer a required dependency of this package and has been removed. This package can now be installed as a standalone.
  • Creating an Arguments object with Parser.ParseArguments is now much simpler. You can use it directly without commands to create minimal CLIs in Program.cs. This will be particularly useful with the upcoming .NET 10 feature allowing direct execution of .cs files. (A demo video with examples and best practices will be released when this feature is available.)
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  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 is compatible.  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.

  • net8.0

    • No dependencies.

  • net9.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
2.0.0 34 2 days ago
1.5.0 317 8 months ago
1.4.0 3,599 9 months ago
1.4.0-Alpha 81 9 months ago
1.3.0 93 7/26/2024
1.2.2 128 7/3/2024
1.2.1 126 6/4/2024
1.2.0 152 3/13/2024
1.1.0 141 1/25/2024
1.0.5 142 1/22/2024
1.0.4 127 1/20/2024
1.0.3 118 1/20/2024
1.0.1 136 1/15/2024
1.0.0 127 1/15/2024