Enables two-way serialization for the CommandLineParser library, allowing an options object to be serialized back into a command-line string.
Get Started
$ dotnet add package OutWit.Common.CommandLineReadme
OutWit.Common.CommandLine
Overview
OutWit.Common.CommandLine is a lightweight library designed to simplify serialization and deserialization of command-line arguments in .NET applications. By leveraging attributes from the CommandLine library, it enables seamless mapping of object properties to command-line options and vice versa.
Features
1. Command-Line Serialization
The library allows converting objects into command-line argument strings based on the OptionAttribute.
Example
using OutWit.Common.CommandLine;
using CommandLine;
public class Options
{
[Option('n', "name", Required = true, HelpText = "The name of the user.")]
public string Name { get; set; } = string.Empty;
[Option('a', "age", HelpText = "The age of the user.")]
public int Age { get; set; }
[Option('v', "verbose", HelpText = "Enable verbose mode.")]
public bool Verbose { get; set; }
}
var options = new Options
{
Name = "John",
Age = 30,
Verbose = true
};
string commandLine = options.SerializeCommandLine();
Console.WriteLine(commandLine);
// Output: --name John --age 30 --verbose
2. Command-Line Deserialization
Easily parse command-line arguments into strongly typed objects.
Example
string[] args = { "--name", "John", "--age", "30", "--verbose" };
var options = args.DeserializeCommandLine<Options>();
Console.WriteLine(options.Name); // Output: John
Console.WriteLine(options.Age); // Output: 30
Console.WriteLine(options.Verbose); // Output: True
3. Attribute-Based Configuration
The library uses OptionAttribute from the CommandLine library to define mappings between object properties and command-line options. Supported configurations include:
- Short and long option names
- Required and optional properties
- Help text for documentation
Installation
Install the package via NuGet:
Install-Package OutWit.Common.CommandLine
API Reference
SerializeCommandLine
public static string SerializeCommandLine<T>(this T me)
- Description: Converts an object into a command-line argument string based on
OptionAttributeannotations. - Returns: A
stringrepresenting the serialized command-line arguments.
DeserializeCommandLine
From String
public static T DeserializeCommandLine<T>(this string me)
- Description: Parses a command-line argument string into an object of type
T. - Returns: An instance of
Tpopulated with parsed values.
From String Array
public static T DeserializeCommandLine<T>(this string[] me)
- Description: Parses a string array of command-line arguments into an object of type
T. - Returns: An instance of
Tpopulated with parsed values.
License
Licensed under the Apache License, Version 2.0. See LICENSE.
Attribution (optional)
If you use OutWit.Common.CommandLine in a product, a mention is appreciated (but not required), for example: "Powered by OutWit.Common.CommandLine (https://ratner.io/)".
Trademark / Project name
"OutWit" and the OutWit logo are used to identify the official project by Dmitry Ratner.
You may:
- refer to the project name in a factual way (e.g., "built with OutWit.Common.CommandLine");
- use the name to indicate compatibility (e.g., "OutWit.Common.CommandLine-compatible").
You may not:
- use "OutWit.Common.CommandLine" as the name of a fork or a derived product in a way that implies it is the official project;
- use the OutWit.Common.CommandLine logo to promote forks or derived products without permission.