ReadLine.Reboot 3.1.1

ReadLine.Reboot

ReadLine.Reboot is a reboot of Toni Solarin-Sodara's original ReadLine that is discontinued. It's 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, as long as they run on .NET Framework 4.8 or at least .NET Core 3.1.

Shortcut Guide

Note: Some keys conflict with terminal emulator keybindings.

• *: Conflicts with Alt+Tab on Windows.
• **: Conflicts with Ctrl+Shift+_ on Windows Command Prompt

Installation

Available on NuGet

Visual Studio:

PM> Install-Package ReadLine.Reboot

.NET Core CLI:

dotnet add package ReadLine.Reboot

Comparison

Here, we'll compare some of the base features between Original ReadLine, Latency's ReadLine, and ReadLine.Reboot.

Usage

This section shows you how to use this library to read the lines and manage history. Just add this to the top of the source file you want to use ReadLine.Reboot on:

using ReadLineReboot;

Input

Note: The (prompt>) is optional

Read input

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

Read input with default

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

Read input with custom prompt handler

ReadLine.WritePrompt = (prompt) => Console.Write($">> {prompt}");
string input = ReadLine.Read("(prompt)> ", "default");

Read password

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

Read password with password mask

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

Interrupt reading

ReadLine.Interruptible = true;
ReadLine.InterruptRead();

History management

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

// Get command history
ReadLine.GetHistory();

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

// Clear history
ReadLine.ClearHistory();

// Set history
List<string> newHistory = new() { "apt update", "apt dist-upgrade" };
ReadLine.SetHistory(newHistory);

// Disable history (default)
ReadLine.HistoryEnabled = false;

// Enable history
ReadLine.HistoryEnabled = true;

Auto-Completion

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

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();

You can disable and enable the auto-completion feature below.

// Disable history (default)
ReadLine.AutoCompletionEnabled = false;

// Enable history
ReadLine.AutoCompletionEnabled = true;

Credits

License

MIT License

Copyright (c) 2017 Toni Solarin-Sodara
Copyright (c) 2022 EoflaOE and its companies

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.