WebCLI 1.0.2

WebCLI is a lightweight library for building command line UI in a web browser for AspNetCore web application. Good for making administration panels without frontend development.

Features

• Easy to configure
  • No frontend development required
  • Create command, register it as service and pass to "UseWebCli" and you're good to go
• Based on jQuery Terminal library, it includes its usability features (history in browser, text navigation, hot keys, etc.)
• Provide intermediate output during complex commands execution (see example AsyncMultistepOperationCommand)
• Replace previous output to refresh provided information (see example ProgressBarCommand)

Pre Requirements

Can be installed into web application based on ASP.NET Core 8.0+

Getting started

1. Install NuGet package:

   Install-Package WebCLI
   

2. Create some command:

   namespace App.Commands
   {
       public class HelloWorldCommand : CommandBase<HelloWorldCommand.Options>
       {
           [Verb("helloworld")]
           public class Options
           {
           }
   
           public override Task<string> ExecuteAsync(Options options)
           {
               return Task.FromResult("Hello world!");
           }
       }
   }
   

3. Register command in IServiceCollection:

   var builder = WebApplication.CreateBuilder(args);
   
   builder.Services.AddTransient<HelloWorldCommand>();
   
   var app = builder.Build();
   

4. Enable WebCLI, by calling "UseWebCli" with options:

   var app = builder.Build();
   
   app.UseWebCli(new WebCliOptions(
       [typeof(HelloWorldCommand)]
   ));
   
   await app.RunAsync();
   

5. Run application, open <app url> + /webcli in browser (e.g. http://localhost:5275/webcli) and enter helloworld to see the result

Examples

For command & configuration examples take a look at WebCLI.Examples project. It contains:

• Installation - shows how to connect WebCLI to your application
• HelloWorldCommand - minimal required command configuration
• AsyncOperationCommand - command that performs async operation
• AsyncMultistepOperationCommand - command with intermediate output (doing some async work, printing output, doing more async work, printing more output, etc.)
• ProgressBarCommand - command with output rewriting
• InterruptableCommand - command with operation, that can check on certain steps if user wants to cancel it
• InterruptableActiveCommand - command with operation, that uses cancellation token (which can be used with various async APIs) indicating that user wants to cancel it