Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/waf/prettyprompt
A cross-platform command line input library that provides syntax highlighting, autocompletion, history and multi-line input.
https://github.com/waf/prettyprompt
autocompletion dotnet readline repl syntax-highlighting
Last synced: 1 day ago
JSON representation
A cross-platform command line input library that provides syntax highlighting, autocompletion, history and multi-line input.
- Host: GitHub
- URL: https://github.com/waf/prettyprompt
- Owner: waf
- License: mpl-2.0
- Created: 2021-03-04T16:06:11.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-06-27T15:14:01.000Z (7 months ago)
- Last Synced: 2025-01-04T07:18:02.247Z (8 days ago)
- Topics: autocompletion, dotnet, readline, repl, syntax-highlighting
- Language: C#
- Homepage:
- Size: 1 MB
- Stars: 163
- Watchers: 6
- Forks: 23
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# PrettyPrompt
[](https://www.nuget.org/packages/PrettyPrompt/)
[](https://app.codecov.io/gh/waf/PrettyPrompt)
[](https://github.com/waf/PrettyPrompt/actions/workflows/main.yml)
A cross-platform command line prompt that provides syntax highlighting, autocompletion, history and more! It's `Console.ReadLine()` on steroids.
## Features
- User Experience (UX) features:
- Syntax highlighting support via ANSI escape sequences. Supports both the terminal color palette and full RGB colors.
- Autocompletion menu, with extended documentation tooltips and overload menus.
- Multi-line input with word-wrapping
- Word-wrapping
- History navigation, optionally persistent across sessions, with history filtering (similar to PSReadLine's `HistorySearchBackward`).
- Unsurprising keybindings: Home, End, Ctrl-L to clear screen, Ctrl-C to cancel current line, Ctrl+Space to open autocomplete menu, and more.
- Cross platform copy/paste: Ctrl-Shift-C for copy, Ctrl-V or Shift-Insert for pasting.
- Optionally detects incomplete lines and converts Enter to a "soft newline" (Shift-Enter).
- Optionally autoformats input text as it's typed.
- Works "in-line" on the command line; it doesn't take over the entire terminal window.
- Developer Experience (DX) features:
- Many customization hooks available for configuring PrettyPrompt for your application (see `IPromptCallbacks`).
- Provides a `CancellationToken` for each prompt result, so the end-user of your application can cancel long running tasks via Ctrl-C.
- Fast rendering—PrettyPrompt only renders the diff of what changed, so the screen doesn't flicker as text is redrawn.
## Installation
PrettyPrompt can be [installed from nuget](https://www.nuget.org/packages/PrettyPrompt/) by running the following command:
```
dotnet add package PrettyPrompt
```
## Usage
A simple read-eval-print-loop looks like this:
```csharp
var prompt = new Prompt();
while (true)
{
var response = await prompt.ReadLineAsync("> ");
if (response.IsSuccess) // false if user cancels, i.e. ctrl-c
{
if (response.Text == "exit") break;
Console.WriteLine("You wrote " + response.Text);
}
}
```
The `Prompt` constructor takes optional configuration options for enabling syntax highlighting, autocompletion, and soft-newline configuration.
For a more complete example, see the project in the [`examples`](https://github.com/waf/PrettyPrompt/tree/main/examples/PrettyPrompt.Examples.FruitPrompt) directory.
If you have the [`dotnet example`](https://github.com/patriksvensson/dotnet-example) global tool installed, run the following command in the repository root:
```
dotnet example FruitPrompt
```
## Building from source
This application targets modern .NET (i.e. not .NET Framework), and can be built with either Visual Studio or the normal `dotnet build` command line tool.