ConsoleToolkit 2.0.0

The Console Toolkit is a sophisticated but simple to learn library providing a full set of features for building console applications. It focuses on getting out of the way as quickly as possible so that you can get on with implementing functionality without having to deal with the complications of parsing command line options, parsing user input, or formatting console output in a comprehensible format.

The library includes a declaritive mechanism for specifying command line options. You can specify your commands and options in a clear and simple way and the Toolkit will take care of the validation. You simply declare a handler and the library will call it if the user specifies valid parameters.

Applications that accept multiple commands are fully supported, and the Toolkit even allows you to offer your users an interactive session in which they can issue commands into a custom command line interface. This functionality is provided free, you just need to start the session and define a command to allow the user to exit the session.

Command and command option help is provided automatically. You just need to tell the toolkit which option or command invokes the help text, and your user will be shown syntax and options. If you use the [Description(...)] attribute, your descriptions will automatically formatted and incorporated in the help text.

Command output can be formatted using a custom wrapper over the standard .NET Console object. To access this object you only need to add a parameter of type IConsoleAdapter and you can access features such as tabular data formatting and word wrapping. Colour support is provided through extension methods, so that you can specify .Red(), .Green() etc and the toolkit will worry about switching the Console output colour intelligently on your behalf.

If you need to capture console input from the user, the library provides an input parsing mechanism that supports everything from simple confirmation requests to compound data structures. The library will validate the user's input and provide you with .NET types so that you don't have to parse the strings yourself.

Comprehensive library documentation is available from the project website, but the library has been designed to be unobtrusive and straightforward to use. Follow the getting started guide to get a fully functional and well behaved console application up and running in minutes. You can even choose the parsing standard you prefer. If you want your commands to use DOS convetions, Unix conventions or the current Windows command line conventions, you just select an option and the Toolkit will format your help text and parse the user's arguments using the appropriate rules.

Install-Package ConsoleToolkit -Version 2.0.0
dotnet add package ConsoleToolkit --version 2.0.0
<PackageReference Include="ConsoleToolkit" Version="2.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ConsoleToolkit --version 2.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: ConsoleToolkit, 2.0.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install ConsoleToolkit as a Cake Addin
#addin nuget:?package=ConsoleToolkit&version=2.0.0

// Install ConsoleToolkit as a Cake Tool
#tool nuget:?package=ConsoleToolkit&version=2.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Release Notes

Updated the library to be a netstandard2.0 library. A later release will target an earlier netstandard version, but changes to the library will be required in order to achieve that. Version 1.4.1 will be the last version of the library compatible with .NET 4.0, but I hope to add compatibility with earlier versions than 4.7.1, which is currently the required full framework version.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
2.0.0 2,599 8/26/2018
1.4.1 1,139 2/8/2018
1.4.0-beta3 852 12/31/2017
1.4.0-beta2 715 11/23/2017
1.4.0-beta1 919 11/19/2017
1.3.4 955 11/8/2017
1.3.3 941 11/3/2017
1.3.2 938 10/29/2017
1.3.1 811 9/23/2017
1.3.0-beta3 939 9/5/2017
1.3.0-beta2 819 8/20/2017
1.3.0-beta 727 8/20/2017
1.2.0 1,011 12/11/2016
1.2.0-beta3 828 12/10/2016
1.2.0-beta2 831 12/5/2016
1.2.0-beta 822 12/2/2016
1.1.0 1,070 6/27/2016
1.0.1 1,313 7/9/2015 1,157 7/4/2015 1,117 6/19/2015 1,153 5/12/2015