SoftShell 0.2.3

SoftShell

This free .NET Standard library provides a built-in command shell in your application for various monitoring or manipulation tasks.

Through a terminal interface, such as the console or Telnet (unencrypted!), it is possible to log in and get a shell-like experience with login, command prompt and various commands that can be issued.

Standard commands, such as 'help' and 'exit' exist and more will probably come. Each application can add custom commands or terminal interfaces.

Usage

When the user has signed in, a > command prompt is shown. Commands can then be entered as in the following examples:

help
asm|more
env > variables.txt
exit

Read more

Integrating in your app

// Create the SoftShell host with core commands
using (var shellHost = new SoftShellHost(UserAuthentication.None)) // or create your own user authentication class
{
    // Add your custom commands needing special construction
    shellHost.AddCommand("myapp", "My Application", new MyCustomCommand1(someArgs));
    shellHost.AddCommand("myapp", "My Application", new MyCustomCommand2(someArgs));
    ...

    // Add your remaining custom commands having default constructors
    shellHost.AddCommands("myapp", "My Application", Assembly.GetExecutingAssembly());

    // Support both the console and Telnet terminals
    using (var consoleListener = shellHost.AddTerminalListener(ConsoleTerminalListener.Instance))
    using (var telnetListener = shellHost.AddTerminalListener(
                    new TelnetTerminalListener(IPAddress.Loopback, 23))) // localhost port 23 as example
    {
        // While your application runs...
    }
}

See the ConsoleDemo1 application in the solution for further details.

Creating custom commands

Besides the core commands that come with SoftShell you can create your own custom commands.

Read more

Contribution

Any help developing this library is welcomed.

Ideas for additions and improvements:

• Additional commands
• New terminal interfaces (e.g. web, SSH)
• General improvements
• Documentation and demo projects
• Unit tests
• Publicity (blogs posts etc.)

Feature requests and bug reports

If you discover any bugs or have suggestions for improvements, please report them here.

Disclaimer

The library is under MIT License and provided as-is without any kind of warranty. See the LICENSE file for conditions.