Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tonerdo/readline
A Pure C# GNU-Readline like library for .NET/.NET Core
https://github.com/tonerdo/readline
csharp dotnet-core gnu-readline readline readline-library
Last synced: 4 days ago
JSON representation
A Pure C# GNU-Readline like library for .NET/.NET Core
- Host: GitHub
- URL: https://github.com/tonerdo/readline
- Owner: tonerdo
- License: mit
- Created: 2017-01-16T15:15:38.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2021-08-19T10:49:20.000Z (about 3 years ago)
- Last Synced: 2024-04-13T18:37:39.744Z (7 months ago)
- Topics: csharp, dotnet-core, gnu-readline, readline, readline-library
- Language: C#
- Homepage:
- Size: 85 KB
- Stars: 799
- Watchers: 22
- Forks: 80
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-csharp - ReadLine - A GNU-Readline like library for .NET/.NET Core. (CLI)
- awesome-dotnet-cn - ReadLine - 用于.NET/.NET Core的类似GNU-Readline的库。 (CLI)
- awesome-dotnet - ReadLine - A GNU-Readline like library for .NET/.NET Core. (CLI)
- awesome-dot-dev - ReadLine - A GNU-Readline like library for .NET/.NET Core. (CLI)
- awsome-dotnet - ReadLine - A GNU-Readline like library for .NET/.NET Core. (CLI)
- awesome-dotnet - ReadLine - A GNU-Readline like library for .NET/.NET Core. (CLI)
README
[](https://ci.appveyor.com/project/tonerdo/readline)
[](LICENSE)
[](https://www.nuget.org/packages/ReadLine)
# ReadLine
ReadLine is a [GNU Readline](https://en.wikipedia.org/wiki/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 `netstandard1.3` means that it can be used with .NET Core as well as the full .NET Framework.
## Shortcut Guide
| Shortcut | Comment |
| ------------------------------ | --------------------------------- |
| `Ctrl`+`A` / `HOME` | Beginning of line |
| `Ctrl`+`B` / `←` | Backward one character |
| `Ctrl`+`C` | Send EOF |
| `Ctrl`+`E` / `END` | End of line |
| `Ctrl`+`F` / `→` | Forward one character |
| `Ctrl`+`H` / `Backspace` | Delete previous character |
| `Tab` | Command line completion |
| `Shift`+`Tab` | Backwards command line completion |
| `Ctrl`+`J` / `Enter` | Line feed |
| `Ctrl`+`K` | Cut text to the end of line |
| `Ctrl`+`L` / `Esc` | Clear line |
| `Ctrl`+`M` | Same as Enter key |
| `Ctrl`+`N` / `↓` | Forward in history |
| `Ctrl`+`P` / `↑` | Backward in history |
| `Ctrl`+`U` | Cut text to the start of line |
| `Ctrl`+`W` | Cut previous word |
| `Backspace` | Delete previous character |
| `Ctrl` + `D` / `Delete` | Delete succeeding character |
## Installation
Available on [NuGet](https://www.nuget.org/packages/ReadLine/)
Visual Studio:
```powershell
PM> Install-Package ReadLine
```
.NET Core CLI:
```bash
dotnet add package ReadLine
```
## Usage
### Read input from the console
```csharp
string input = ReadLine.Read("(prompt)> ");
```
### Read password from the console
```csharp
string password = ReadLine.ReadPassword("(prompt)> ");
```
_Note: The `(prompt>)` is optional_
### History management
```csharp
// 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
```csharp
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](https://en.wikipedia.org/wiki/GNU_Readline).
* Add more test cases.
## License
This project is licensed under the MIT license. See the [LICENSE](LICENSE) file for more info.