Loudenvier.ReadLine 2.0.1.4

This fork of tornedo's ReadLine is aimed at solving bugs (contributed as PR's to main) and adding small improvements/new features (marked as such on the readme file). It's a drop-in replacement: simply change the nuget from ReadLine to Loudenvier.ReadLine (the nuget version is based on the original ReadLine package version)

ReadLine

ReadLine is a GNU Readline like library built in pure C#. It can serve as a drop in replacement for the inbuilt Console.ReadLine() and brings along with it some of the terminal goodness you get from unix shells, like command history navigation and tab auto completion.

It is cross platform and runs anywhere .NET is supported, targeting netstandard2.0 means that it can be used with .NET and .NET Framework.

Shortcut Guide

Installation

Available on NuGet

Visual Studio:

PM> Install-Package Loudenvier.ReadLine

.NET Core CLI:

dotnet add package Loudenvier.ReadLine

Loudenvier's changes

• Fixed a bug with CTRL+LEFT_ARROW/RIGHT_ARROW creating havoc in editing
• Added support to navigate to PREVIOUS/NEXT word (CTRL+LEFT/RIGHT)
• Added support for case changing commands (ALT+U/C/L)
• Added support for CTRL+BACKSPACE to delete previous word
• Fixed a bug in which unknown key combinations where messing the text buffer
• Improved demo program

Usage

Read input from the console

string input = ReadLine.Read("(prompt)> ");

Read password from the console

string password = ReadLine.ReadPassword("(prompt)> ");

Note: The (prompt>) is optional

History management

// Get command history
ReadLine.GetHistory();

// Add command to history
ReadLine.AddHistory("dotnet run");

// Clear history
ReadLine.ClearHistory();

// Disable history
ReadLine.HistoryEnabled = false;

Note: History information is persisted for an entire application session. Also, calls to ReadLine.Read() automatically adds the console input to history

Auto-Completion

class AutoCompletionHandler : IAutoCompleteHandler
{
    // characters to start completion from
    public char[] Separators { get; set; } = new char[] { ' ', '.', '/' };

    // text - The current text entered in the console
    // index - The index of the terminal cursor within {text}
    public string[] GetSuggestions(string text, int index)
    {
        if (text.StartsWith("git "))
            return new string[] { "init", "clone", "pull", "push" };
        else
            return null;
    }
}

ReadLine.AutoCompletionHandler = new AutoCompletionHandler();

Note: If no "AutoCompletionHandler" is set, tab autocompletion will be disabled

Contributing

Contributions are highly welcome. If you have found a bug or if you have a feature request, please report them at this repository issues section.

Things you can help with:

• Achieve better command parity with GNU Readline.
• Add more test cases.

License

This project is licensed under the MIT license. See the LICENSE file for more info.