VoidMain is a framework for building command-line applications. Inspired by ASP.NET Core. Almost every part of the framework can be extended or replaced.
The framework is still in early development. The API is not final and some features are missing or incomplete. The work on the documentation and performance is not started yet.
The current state of planned features:
- Command-line interface
- Masked/hidden input
- Undo/redo
- Commands history
- Custom prompt message
- Syntax highlighting*
- Autocomplete
- Standard commands
- Clear output
- Close application
- Show help
- Show version
- Configuration
- Method signature
- Attributes
- Expression trees
* Errors highlighting is not supported yet.
Simple configuration
public class ExampleModule : CommandsModule
{
public void Hello([Operand] string name)
{
Output.WriteLine($"Hello, {name}!");
}
[Command(Name = "command name")]
public void Command(string[] operands, string option, bool flag = false)
{
Output.WriteLine("Command was executed.");
}
}class Program : IStartup
{
static void Main(string[] args)
{
CliApp.Run<Program>();
}
public void ConfigureServices(IServiceCollection services)
{
services.AddConsoleInterface();
services.AddCommands();
}
public void ConfigureApplication(IApplicationBuilder app)
{
app.UseHelpCommandsRewriter();
app.RunCommands(commands =>
{
commands.AddStandardCommands();
commands.AddHelpCommands();
commands.AddModule<ExampleModule>();
});
}
}CMD> example hello world
You can get rid of the example command name part if you configure the ExcludeFromCommandName property for the module.
[Module(ExcludeFromCommandName = true)]
public class ExampleModule : CommandsModule { }CMD> hello world
Advanced configuration
public void ConfigureServices(IServiceCollection services)
{
services.AddConsoleInterfaceCore()
.AddPromptMessage("CMD> ")
.AddUndoRedo(options =>
{
options.MaxCount = 10;
options.SnapshotsComparer = LineViewSnapshotComparer.IgnoreCursor;
})
.AddSyntaxHighlighting(options =>
{
options.Palette = new CommandLineHighlightingPalette()
{
{ CommandLineStyleName.CommandName, Color.Yellow },
{ CommandLineStyleName.OptionName, Color.Blue, Color.Yellow },
{ CommandLineStyleName.Operand, new TextStyle(Color.DarkCyan) }
// OptionNameMarker, OptionValueMarker, OptionValue, EndOfOptions
};
// or
options.Palette = CommandLineHighlightingPalette.Default;
})
.AddCommandsHistory(options =>
{
options.MaxCount = 10;
options.SavePeriod = TimeSpan.FromSeconds(10);
options.CommandsComparer = StringComparer.Ordinal;
})
.AddFileStorage(options =>
{
options.FilePath = "history.txt";
options.Encoding = Encoding.UTF8;
});
services.AddCommands();
}MIT License. See LICENSE file for more details.