DigitalZenWorks.CommandLine.Commands 1.1.6

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

// Install DigitalZenWorks.CommandLine.Commands as a Cake Tool
#tool nuget:?package=DigitalZenWorks.CommandLine.Commands&version=1.1.6                

DigitalZenWorks.Email.ToolKit

This C# client library that provides light weight functionality to help process command line options.

Getting Started

Installation

Git
git clone  https://github.com/jamesjohnmcguire/CommandLineCommands  
Nuget
PM> Install-Package DigitalZenWorks.CommandLine.Commands

Usage:

Library and API usage:

Usage is intended to be simple and direct - Process command line arguments and get going with your business.

First, create a list of commands that the application will support, such as:

	IList<Command> commands = new List<Command>();

	Command help = new ("help");
	help.Description = "Show this information";
	commands.Add(help);

	CommandOption encoding = new ("e", "encoding", true);
	IList<CommandOption> options = new List<CommandOption>();
	options.Add(encoding);

	Command someCommand = new (
		"some-command", options, 1, "A Do Something Command");
	commands.Add(someCommand);

The third parameter is the minimum amount of required parameters, such as data file path. The other parameters should be self-explanatory.

Then instantiate a CommandLineArguments object:

	CommandLineArguments commandLine = new (commands, arguments);

If all goes well and the supplied arguments pass validation, the active command object will be available, and you can get on your way:

	if (commandLine.ValidArguments == true)
	{
		Command command = commandLine.Command;

		switch (command.Name)
		{
			case "some-command":
				DoSomething(command);
				break;
		}
	}

Getting the associated additional parameters and options, can be done as follows:

	string dataFilePath = command.Parameters[0];

	bool dryRun = command.DoesOptionExist("n", "dryrun");

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

Process:

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Coding style

Please match the current coding style. Most notably:

  1. One operation per line
  2. Use complete English words in variable and method names
  3. Attempt to declare variable and method names in a self-documenting manner

License

Distributed under the MIT License. See LICENSE for more information.

Contact

James John McGuire - @jamesmc - jamesjohnmcguire@gmail.com

Project Link: https://github.com/jamesjohnmcguire/CommandLineCommands

Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  net5.0-windows was computed.  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 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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 is compatible.  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)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

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
1.1.6 119 4/9/2024
1.1.5 254 10/20/2023
1.1.4 121 9/10/2023
1.0.2 196 10/31/2022