WMCommandFramework.NETStandard 0.2.5

Suggested Alternatives

CommandSharp 2.9.4

dotnet add package WMCommandFramework.NETStandard --version 0.2.5                
NuGet\Install-Package WMCommandFramework.NETStandard -Version 0.2.5                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="WMCommandFramework.NETStandard" Version="0.2.5" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add WMCommandFramework.NETStandard --version 0.2.5                
#r "nuget: WMCommandFramework.NETStandard, 0.2.5"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install WMCommandFramework.NETStandard as a Cake Addin
#addin nuget:?package=WMCommandFramework.NETStandard&version=0.2.5

// Install WMCommandFramework.NETStandard as a Cake Tool
#tool nuget:?package=WMCommandFramework.NETStandard&version=0.2.5                

WMCommandFramework - WMCommandFramework.NETStandard

WMCommandFramework is a simple command processor built in C# to be used with .NETStandard, WinForms, and .NETCore. WMCommandFramework can be used to easily create commands for .NETStandard-based projects and applications.

In the COSMOS kernel class implement the CommandProcessor class.

using System;
using Sys = Cosmos.System;
//Import the CommandFramework.
using CMD = WMCommandFramework.COSMOS;

public Kernel : Sys.Kernel
{
  //Add the command processor class.
  private static CMD.ComamndProcessor processor;
  
  protected override void BeforeRun()
  {
    if (processor == null) processor = new CMD.CommandProcessor();
    //Used for displaying version information when a lone --version is used.
    processor.Version = new CMD.ApplicationVersion("WMCommandFramework Example OS", new CMD.CommandCopyright("Vanros Corperation"), new CMD.CommandVersion(1, 1, 0, "STABLE"));
    //Replaces `CommandUtil.CurrentToken`.
    processor.Message = new CMD.InputMessage[] { new CMD.InputMessage(ConsoleColor.Cyan, "$administrator"), new CMD.InputMessage(ConsoleColor.Green, "@WMCommandFrameworkOS"), CMD.InputMessage.NewLine };
    //Register Commands:
    processor.GetInvoker().AddCommand(new ExampleCommand());
    //Loop login prompt until the user logs in.
    while (true)
    {
      var access = processor.LoginPrompt("administrator", "password");
      if (access) break;
    }
  }
  
  protected override void Run()
  {
    processor.Process();
  }
}

Once the CommandProcessor was implemented into the COSMOS Kernel you need to create the command. Create a new class that implements the abstract Command class.

using System;
using System.Collections.Generic;
using System.Text;

namespace Project.Commands
{
    public class ExampleCommand : Command
    {
        public override string[] CommandAliases()
        {
            return new string[0]; //Means there's no aliases.
        }

        public override string CommandDesc()
        {
            return "Prints the specified information to the console.";
        }

        public override string CommandName()
        {
            return "example";
        }

        public override string CommandSynt()
        {
            return "<message>";
        }

        public override CommandVersion CommandVersion()
        {
            return new WMCommandFramework.CommandVersion(1,0,1,"b");
        }

        public override void OnCommandInvoked(CommandInvoker invoker, CommandArgs args)
        {
            if (args.IsEmpty()) throw new Exceptions.SyntaxException("The \"message\" argument cannot be null or empty.");
            else
            {
                Console.WriteLine($"{args.GetArgAtPosition(0)}");
            }
        }
    }
}

After the class containing the command was created and was implemented into the CommandInvoker class it should work in your OS. Just be sure to register your command with the command invoker if you haven't done so already, but if you followed this README then the command would have been registered before the command was created.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETStandard 2.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.