Abstraction layer on top of the System.CommandLine library, that allows definining commands in a declarative way, using attributes.
Get Started
$ dotnet add package DeclarativeCommandLine.GeneratorReadme
Declarative Command Line
Attribute-driven layer on top of System.CommandLine to make the most common use cases easier to set up.
Minimalistic Example
A minimal example, using DI to instantiate command objects:
Add NuGet Packages
2 packages are needed:
- DeclarativeCommandLine: Contains attributes used to decorate commands, options and arguments;
- DeclarativeCommandLine.Generator: The source generator that actually constructs the System.CommandLine client code. Only used on compile time.
<ItemGroup>
<PackageReference Include="DeclarativeCommandLine" Version="2.0.4" />
<PackageReference Include="DeclarativeCommandLine.Generator" Version="2.0.4" />
<PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="9.0.9"/>
</ItemGroup>
Program.cs
using DeclarativeCommandLine;
using Microsoft.Extensions.DependencyInjection;
namespace MyApp;
[Command(Description = "Math commands")]
public class AppRootCommand
{
}
[Command(Description = "Add 2 numbers", Parent = typeof(AppRootCommand))]
public class AddCommand : ICommand
{
[Option(Required = true)]
public int ValueA { get; set; }
[Option(Required = true)]
public int ValueB { get; set; }
public void Execute()
{
Console.WriteLine($"A={ValueA} + {ValueB} = {ValueA + ValueB}");
}
}
public static class Program
{
public static int Main(string[] args)
{
var p = new ServiceCollection()
.AddTransient<AppRootCommand>()
.AddTransient<AddCommand>()
.BuildServiceProvider();
return new CommandBuilder()
.Build(t => p.GetRequiredService(t))
.Parse(args)
.Invoke();
}
}