Micro-framework for .NET Core console application. Cocona makes it easy and fast to build console applications on .NET.
public
method as a command ™getopt
/getopt_long
like options)
-rf /
and -r -f /
:-)myapp --foo --bar -n arg0 "arg1"
(e.g. dir
, cp
, ls
...)myapp server -m "Hello world!"
(e.g. dotnet
, git
, kubectl
...)-h
or --help
.bash
and zsh
Microsoft.Extensions.*
framework. Cocona natively supports Logging, DI, Configuration and ConsoleLifetime.Microsoft.Extensions.*
? then you can use a lightweight version of Cocona (named Cocona.Lite).You can find sample code for various features.
Install NuGet package from NuGet.org
$ dotnet add package Cocona
PS> Install-Package Cocona
using Cocona;
class Program
{
static void Main(string[] args)
{
// Cocona parses command-line and executes a command.
CoconaApp.Run<Program>(args);
}
// public method as a command ™
public void Hello(string name)
{
Console.WriteLine($"Hello {name}");
}
}
$ dotnet run
Usage: ConsoleAppSample [--name <String>]
Options:
--name <String> (Required)
-h, --help Show help message
--version Show version
$ dotnet run -- --name Cocona
Hello Cocona
If your application runs on .NET Core 3.0 or later, you can publish the app as a single-file executable. (see. What's new in .NET Core 3.0)
PS> dotnet publish -r win-x64 -p:PublishSingleFile=true
PS> app.exe --name Cocona
$ dotnet publish -r linux-x64 -p:PublishSingleFile=true
$ ./app --name Cocona
By default, Cocona treats public
methods as commands.
If an application has one public method, Cocona calls it on startup. If there are more than one, they are treated as sub-commands. (see also Sub commands)
// Treats a method name as a command name. (Below method is named `command`)
public void Command() { ... }
// Specify a command name using CommandAttribute.
[Command("commandname")]
public void Command() { ... }
// Cocona will ignore this method.
[Ignore]
public void Ignored() { ... }
If you want to specify a method as a command manually, set false
to TreatPublicMethodsAsCommands
option at startup. All command methods require CommandAttribute
.
CoconaApp.Run<Program>(args, options =>
{
// If the option value is `false`, All command methods require `CommandAttribute`.
options.TreatPublicMethodsAsCommands = false;
});
Cocona exposes method parameters as command-line options (also known as flags).
// This command accepts `--name <string>` and `--hey` options.
public void Hello(string name, bool hey) { ... }
If method parameters are optional argument, Cocona treats those as optional command options. (That is, the parameters are treated as required option by default excepts boolean).If a parameter is boolean, it's assumed that false
default value is specified.
// `--name "default user"` is specified implicity.
public void Hello(string name = "default user") { ... }
Do you want to use short-name option -f
instead of --force
?You can specify short-name to an option using OptionAttribute
.
// The command accepts `-f` or `--force` option.
// Cocona's command-line parser accepts getopt-like styles. See below.
// $ remove --force --recursive
// $ remove -r -f
// $ remove -rf
public void Remove([Option('f')]bool force, [Option('r')]bool recursive) { ... }
If a parameter is T[]
or IEnumerable<T>
, a command accepts one or more options by the same name.
// $ compile -I../path/to/foo.h -I/usr/include/bar.h -I/usr/include/baz.h nantoka.c
// include = new [] { "../path/to/foo.h", "/usr/include/bar.h", "/usr/include/baz.h" };
public void Compile([Option('I')]string[] include, [Argument]string file) { ... }
You can also specify a description for options that appear in the help.
public void HasDescription([Option(Description = "Description of the option")] int value, [Argument(Description = "Description of the argument")]string arg) { ... }
Usage: CoconaSample.InAction.CommandOptions has-description [--value <Int32>] [--help] arg
Arguments:
0: arg Description of the argument (Required)
Options:
--value <Int32> Description of the option (Required)
-h, --help Show help message
Command-line arguments are defined as method parameters as same as options.
// ./app alice karen
public void Hello([Argument]string from, [Argument]string to) { ... }
You can define a parameter as T[]
. It allows defining cp
-like command which accepts many file paths and one destination path (cp file1 file2 file3 dest
).
// ./copy file1 file2 file3 dest
public void Copy([Argument]string[] src, [Argument]string dest) { ... }
If a command type has more than one public method or [Command]
, those commands are exposed as sub-commands. You can implement an application that has sub-commands similar to dotnet
, git
, kubectl
etc...
static void Main(string[] args)
{
CoconaApp.Run<Program>(args);
}
[Command(Description = "Say hello")]
public void Hello([Argument]string name)
{
Console.WriteLine($"Hello {name}!");
}
[Command(Description = "Say goodbye")]
public void Bye([Argument]string name)
{
Console.WriteLine($"Goodbye {name}!");
}
$ ./SubCommandApp
Usage: SubCommandApp [command]
Usage: SubCommandApp [--help] [--version]
SubCommandApp
Commands:
hello Say hello
bye Say goodbye
Options:
-h, --help Show help message
--version Show version
When a user mistypes a command, Cocona prints command autogenerated suggestions.
$ ./SubCommandApp hell
Error: 'hell' is not a command. See '--help' for usage.
Similar commands:
hello
Cocona also supports nested sub-commands. Specify the class that has nested sub-commands using HasSubCommands
attribute.
[HasSubCommands(typeof(Server), Description = "Server commands")]
[HasSubCommands(typeof(Client), Description = "Client commands")]
class Program
{
static void Main(string[] args) => CoconaApp.Run<Program>(args);
// ./myapp info
public void Info() => Console.WriteLine("Show information");
}
// ./myapp server [command]
class Server
{
public void Start() => Console.WriteLine("Start");
public void Stop() => Console.WriteLine("Stop");
}
// ./myapp client [command]
class Client
{
public void Connect() => Console.WriteLine("Connect");
public void Disconnect() => Console.WriteLine("Disconnect");
}
$ ./SubCommandApp
Usage: SubCommandApp [command]
Usage: SubCommandApp [--help] [--version]
SubCommandApp
Commands:
info
server Server commands
client Client commands
Options:
-h, --help Show help message
--version Show version
$ ./SubCommandApp server
Usage: SubCommandApp server [command]
Usage: SubCommandApp server [--help]
SubCommandApp
Commands:
start
stop
Options:
-h, --help Show help message
[PrimaryCommand]
public void Primary(bool foo, string bar) { ... }
[Command]
public void Hello() { ... }
[Command]
public void Goodbye() { ... }
The option-like command is a way to achieve an independent command that at first glance, looks like an option in a command.
For example, easy to understand examples like --version
and --help
.These are the options of a command, but they behave as a command when specified.
[OptionLikeCommand("hello", new[] {'f'}, typeof(Program), nameof(Hello))]
public void Execute()
=> Console.WriteLine("Execute");
private void Hello([Argument]string name)
=> Console.WriteLine($"Hello {name}!");
$ ./myapp
Execute
$ ./myapp --hello Alice
Hello Alice!
--foo --bar --optionlikecommand --baz arg0
and --optionlikecommand
is an Option-like command, the command will be passed --baz arg0
.Cocona has a mechanism called Parameter set that defines common parameters for multiple commands.For example, if every command receives a user name, host name, etc., it would be annoying to define them in a method for each command.
A class or record
implements the ICommandParameterSet
interface and treats it as a Parameter set.
If a class (or record class) has a parameterized constructor, it is treated as part of the definition of a command method.
public record CommonParameters(
[Option('t', Description = "Specifies the remote host to connect.")]
string Host,
[Option('p', Description = "Port to connect to on the remote host.")]
int Port,
[Option('u', Description = "Specifies the user to log in as on the remote host.")]
string User = "root",
[Option('f', Description = "Perform without user confirmation.")]
bool Force = false
) : ICommandParameterSet;
public void Add(CommonParameters commonParams, [Argument] string from, [Argument] string to)
=> Console.WriteLine($"Add: {commonParams.User}@{commonParams.Host}:{commonParams.Port} {(commonParams.Force ? " (Force)" : "")}");
public void Update(CommonParameters commonParams, [Option('r', Description = "Traverse recursively to perform.")] bool recursive, [Argument] string path)
=> Console.WriteLine($"Update: {commonParams.User}@{commonParams.Host}:{commonParams.Port} {(commonParams.Force ? " (Force)" : "")}");
If a class has a parameter-less constructor, you can mark the public property as Option
or Argument
.
NOTE: Option defined as a property is treated as required by default. If you want a non-required Option to have a default value, mark it with HasDefaultValue
attribute.
public class CommonParameters : ICommandParameterSet
{
[Option('t', Description = "Specifies the remote host to connect.")]
public string Host { get; set; }
[Option('p', Description = "Port to connect to on the remote host.")]
public int Port { get; set; }
[Option('u', Description = "Specifies the user to log in as on the remote host.")]
[HasDefaultValue]
public string User { get; set; } = "root";
[Option('f', Description = "Perform without user confirmation.")]
public bool Force { get; set; } = false;
}
public void Add(CommonParameters commonParams, [Argument] string from, [Argument] string to)
=> Console.WriteLine($"Add: {commonParams.User}@{commonParams.Host}:{commonParams.Port} {(commonParams.Force ? " (Force)" : "")}");
public void Update(CommonParameters commonParams, [Option('r', Description = "Traverse recursively to perform.")] bool recursive, [Argument] string path)
=> Console.WriteLine($"Update: {commonParams.User}@{commonParams.Host}:{commonParams.Port} {(commonParams.Force ? " (Force)" : "")}");
// Exit Code: 0
public void NoReturn() { }
// Exit Code: 123
public int Return() { return 123; }
// Exit Code: 255
public async Task<int> ReturnAsync() { return 255; }
// Exit Code: -1
public async ValueTask<int> ReturnValueTaskAsync() { return -1; }
// Exit Code: 128
public void Throw() { throw new CommandExitedException(128); }
Cocona can use attributes to validate options and arguments. It is similar to ASP.NET Core MVC.
.NET BCL (System.ComponentModel.DataAnnotations
) has some pre-defined attributes:
RangeAttribute
MaxLangeAttribute
MinLengthAttribute
If you want to implement custom validation attribute, it should inherit System.ComponentModel.DataAnnotations.ValidationAttribute
attribute.
class Program
{
static void Main(string[] args)
{
CoconaApp.Run<Program>(args);
}
public void Run([Range(1, 128)]int width, [Range(1, 128)]int height, [Argument][PathExists]string filePath)
{
Console.WriteLine($"Size: {width}x{height}");
Console.WriteLine($"Path: {filePath}");
}
}
class PathExistsAttribute : ValidationAttribute
{
protected override ValidationResult IsValid(object value, ValidationContext validationContext)
{
if (value is string path && (Directory.Exists(path) || Directory.Exists(path)))
{
return ValidationResult.Success;
}
return new ValidationResult($"The path '{value}' is not found.");
}
}
class Program : CoconaConsoleAppBase
{
...
public async Task RunAsync()
{
while (!Context.CancellationToken.IsCancellationRequested)
{
await Task.Delay(100);
}
}
}
Alternatively, you can use ICoconaAppContextAccessor
and CoconaAppContext
to access CancellationToken
.
public async Task RunAsync([FromService]ICoconaAppContextAccessor contextAccessor)
{
var ctx = contextAccessor.Current ?? throw new InvalidOperationException();
while (!ctx.CancellationToken.IsCancellationRequested)
{
await Task.Delay(100);
}
}
Cocona has filter mechanism like ASP.NET Core's action filter. Filters allow custom processing before or after you run a command.
ICommandFilter
interfaceCommandFilterAttribute
attributeIFilterProvider
interfaceIFilterMetadata
interfaceclass Program
{
static void Main(string[] args)
{
CoconaApp.Run<Program>(args);
}
[SampleCommandFilter]
public void Hello()
{
Console.WriteLine($"Hello Konnichiwa");
}
}
class SampleCommandFilterAttribute : CommandFilterAttribute
{
public override async ValueTask<int> OnCommandExecutionAsync(CoconaCommandExecutingContext ctx, CommandExecutionDelegate next)
{
Console.WriteLine($"Before Command: {ctx.Command.Name}");
try
{
return await next(ctx);
}
finally
{
Console.WriteLine($"End Command: {ctx.Command.Name}");
}
}
}
If a constructor has parameters, Cocona injects an instance obtained from IServiceProvider into the parameter. Cocona will also inject an instance into the parameter if a command method parameter is marked as [FromService]
.
class Program
{
public Program(ILogger<Program> logger)
{
logger.LogInformation("Create Instance");
}
static void Main(string[] args)
{
CoconaApp.Create()
.ConfigureServices(services =>
{
services.AddTransient<MyService>();
})
.Run<Program>(args);
}
public void Hello([FromService]MyService myService)
{
myService.Hello("Hello Konnichiwa!");
}
}
class MyService
{
private readonly ILogger _logger;
public MyService(ILogger<MyService> logger)
{
_logger = logger;
}
public void Hello(string message)
{
_logger.LogInformation(message);
}
}
class Program : CoconaConsoleAppBase
{
static void Main(string[] args)
{
CoconaApp.Create()
.ConfigureLogging(logging =>
{
logging.AddDebug();
})
.Run<Program>(args);
}
public async Task RunAsync()
{
Context.Logger.LogInformation("Hello Konnichiwa!");
}
}
Cocona provides support for shell command-line completion (also known as tab completion).
Cocona generates a shell script for command-line completion from a command definition and allows users to use command-line completion by loading it. The --completion
built-in option is used to specify the name of a shell to generate a script.
$ source <(./myapp --completion bash)
or
% ./myapp --completion zsh > ~/.zsh/functions
Currently, The supported shells are bash
and zsh
.
This feature is enabled by default, or you can set the EnableShellCompletionSupport
option to false
if you don't need it.
It is also possible to dynamically generate command-line completion candidates and to prepare candidates at script generation time. Please see the sample below for more details.
Microsoft.Extensions.*
are powerful but little heavy libraries. If you don't needMicrosoft.Extensions.*
, you can use a lightweight version of Cocona. (named Cocona.Lite)
Microsoft.Extensions.*
dependencies
Just install NuGet package Cocona.Lite
instead of Cocona
.
$ dotnet add package Cocona.Lite
Then in your source code, use CoconaLiteApp
class instead of CoconaApp
class.
static void Main(string[] args)
{
CoconaLiteApp.Run<Program>(args);
}
BenchmarkDotNet=v0.12.0, OS=Windows 10.0.18363
Intel Core i7-8650U CPU 1.90GHz (Kaby Lake R), 1 CPU, 8 logical and 4 physical cores
.NET Core SDK=3.1.101
[Host] : .NET Core 3.1.1 (CoreCLR 4.700.19.60701, CoreFX 4.700.19.60801), X64 RyuJIT
DefaultJob : .NET Core 3.1.1 (CoreCLR 4.700.19.60701, CoreFX 4.700.19.60801), X64 RyuJIT
Method | Mean | Error | StdDev | Ratio | RatioSD | Rank |
---|---|---|---|---|---|---|
Cocona.Lite | 50.15 us | 0.952 us | 1.058 us | 1.00 | 0.00 | 1 |
CommandLineParser | 51.22 us | 1.004 us | 1.157 us | 1.02 | 0.03 | 1 |
CliFx | 57.73 us | 1.128 us | 1.427 us | 1.15 | 0.03 | 2 |
McMaster.Extensions.CommandLineUtils | 188.98 us | 3.707 us | 5.316 us | 3.76 | 0.13 | 3 |
Clipr | 203.84 us | 4.706 us | 13.350 us | 3.90 | 0.19 | 4 |
System.CommandLine | 239.53 us | 4.762 us | 8.827 us | 4.73 | 0.25 | 5 |
PowerArgs | 352.29 us | 7.681 us | 13.043 us | 6.96 | 0.28 | 6 |
Cocona | 1,836.93 us | 35.555 us | 50.992 us | 36.90 | 1.44 | 7 |
The CommandMethodForwardedTo
attribute allows you to specify that the substance of the specified command method is a different method and that the operation should be forwarded.If this attribute is given to a command method, the destination's attribute and its implementation are used. Excepts for the Command
and Hidden
attributes specified by the method.
For example, it can be used if the command implementation is defined in an external assembly or to call a built-in command (such as help) or compatibility purposes.
[CommandMethodForwardedTo(typeof(BuiltInOptionLikeCommands), nameof(BuiltInOptionLikeCommands.ShowHelp))]
public void MyHelp()
=> throw new NotSupportedException(); // NOTE: The method body and parameters used is BuiltInOptionLikeCommands.ShowHelp.
Cocona treats unknown options as errors by default.Now, you can set the IgnoreUnknownOptions attribute to ignore unknown options.
Cocona can be integrated with GenericHost of Microsoft.Extensions.Hosting.You can register the services with UseCocona
extension method.
class Program
{
static async Task Main(string[] args)
{
await Host.CreateDefaultBuilder()
.UseCocona(args, new[] { typeof(Program) })
.Build()
.RunAsync();
}
public void Hello()
{
Console.WriteLine($"Hello Konnichiwa!");
}
}
MIT License
Copyright © 2020-present Mayuki Sawatari <mayuki@misuzilla.org>