NextGenSoftware.CLI.Engine 2.0.2

There is a newer version of this package available.
See the version list below for details.
dotnet add package NextGenSoftware.CLI.Engine --version 2.0.2
                    
NuGet\Install-Package NextGenSoftware.CLI.Engine -Version 2.0.2
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="NextGenSoftware.CLI.Engine" Version="2.0.2" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="NextGenSoftware.CLI.Engine" Version="2.0.2" />
                    
Directory.Packages.props
<PackageReference Include="NextGenSoftware.CLI.Engine" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add NextGenSoftware.CLI.Engine --version 2.0.2
                    
#r "nuget: NextGenSoftware.CLI.Engine, 2.0.2"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package NextGenSoftware.CLI.Engine@2.0.2
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=NextGenSoftware.CLI.Engine&version=2.0.2
                    
Install as a Cake Addin
#tool nuget:?package=NextGenSoftware.CLI.Engine&version=2.0.2
                    
Install as a Cake Tool

NextGenSoftware.CLI.Engine

A feature-rich CLI engine for .NET — colour output, animations, spinners, tables, progress bars, ASCII art, interactive prompts, and more. The terminal backbone of the OASIS Omniverse ecosystem, used in HoloNET, the OASIS API CLI, STAR ODK, and OurWorld.

NuGet License: MIT .NET

Part of the OASIS Omniverse v2.0 Reboot. Visit oasisomniverse.one.


Features

  • Rich colour output — full 16-colour and RGB console support
  • Animated working-message spinners with inline DONE on the same line
  • Formatted tables — single and multi-column layouts
  • Progress bars with percentage and custom messages
  • ASCII art banners for CLI app headers
  • Interactive prompts — validated text, password, confirmation, colour pickers
  • SupressConsoleLogging — toggle all output on/off at runtime
  • Cross-platform: Windows, macOS, Linux
  • Multi-target: .NET 8, .NET 9, .NET 10

Installation

dotnet add package NextGenSoftware.CLI.Engine

Working Message Spinner

CLIEngine.BeginWorkingMessage("Connecting to Holochain conductor...");
await client.ConnectAsync();
CLIEngine.EndWorkingMessage(); // prints " DONE" on the same line

Coloured Messages

CLIEngine.ShowSuccessMessage("All packages published!");
CLIEngine.ShowErrorMessage("Connection failed.");
CLIEngine.ShowWarningMessage("Proceeding with defaults.");
CLIEngine.ShowMessage("Custom text", ConsoleColor.Cyan);

Tables

CLIEngine.ShowDivider();
CLIEngine.ShowTable(
    new[] { "Package", "Version", "Status" },
    new[] {
        new[] { "NextGenSoftware.WebSocket", "2.0.1", "Published" },
        new[] { "NextGenSoftware.Logging",   "2.0.1", "Published" },
    }
);

Interactive Input

string name  = CLIEngine.GetValidInput("Enter your name:");
string pass  = CLIEngine.GetValidPassword("Enter password:");
bool confirm = CLIEngine.GetConfirmation("Are you sure? (y/n)");

Method Reference

Method Description
ShowMessage Print text in any console colour
ShowSuccessMessage Green success output
ShowErrorMessage Red error output with optional exception
ShowWarningMessage Yellow warning output
BeginWorkingMessage Start animated spinner
EndWorkingMessage Stop spinner, print DONE inline
ShowDivider Print a horizontal rule
ShowTable Render a formatted table
ShowProgressBar Progress bar for long operations
WriteAsciMessage Print ASCII art banner
GetValidInput Prompt for validated text
GetValidPassword Prompt for masked password
GetConfirmation Prompt for yes/no
GetValidColour Prompt for a console colour

MIT — Copyright (c) NextGen Software Ltd 2019 - 2026

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on NextGenSoftware.CLI.Engine:

Package Downloads
NextGenSoftware.Logging

A flexible, pluggable logging library with a clean ILogger/ILogProvider abstraction used across the entire NextGen Software ecosystem (OASIS, HoloNET, STAR). Supports multiple simultaneous log providers -- console, file, NLog, and custom implementations. Configurable log levels, formatting, and async log dispatch. Part of the OASIS Omniverse ecosystem at https://oasisomniverse.one -- Source: https://github.com/NextGenSoftwareUK/NextGenSoftware-Libraries

NextGenSoftware.OASIS.STAR.CLI.Lib

Core library for the STAR ODK command-line interface — exposes all STAR CLI commands as a reusable library so they can be embedded in other tools and UIs.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
2.0.3 38 7/14/2026
2.0.2 49 7/14/2026
2.0.1 33 7/14/2026
2.0.0 57 7/13/2026
1.3.0 1,075 5/26/2024
1.2.0 1,105 5/22/2023
1.1.2 1,478 12/28/2022
1.1.1 7,116 8/27/2022
1.1.0 888 8/25/2022
1.0.3 1,302 8/24/2022
1.0.2 560 8/23/2022
1.0.1 537 8/23/2022
1.0.0 1,591 8/22/2022

## v2.0.1 — OASIS Omniverse Reboot (2026)

Part of the biggest NextGen Software release in years! The full OASIS Omniverse ecosystem — powering Our World, the OASIS API (85+ NuGet packages), HoloNET (Holochain .NET client), STAR ODK, and more — has been fully relaunched and rebranded at https://oasisomniverse.one/

After years of continuous development this is the first major v2 release, representing a complete overhaul and modernisation of the entire NextGen Software foundation.

### What's New in v2.0.1
- Added .NET 10 support: now multi-targeting net8.0, net9.0, and net10.0 for future-proof compatibility
- Copyright updated: NextGen Software Ltd 2019 - 2026
- Part of the unified OASIS Omniverse ecosystem at https://oasisomniverse.one/
- Added BeginWorkingMessage/EndWorkingMessage for animated long-operation feedback with inline DONE confirmation
- Added nextMessageOnSameLine to all ShowMessage overloads
- Added SupressConsoleLogging property to toggle console output at runtime
- Integrated NextGenSoftware.ErrorHandling for structured exception reporting
- Improved cross-platform rendering compatibility (Linux, macOS, Windows)
- Significantly improved error handling, robustness, and API consistency
- Multiple bug fixes and stability improvements
- Open source under MIT licence — https://github.com/NextGenSoftwareUK/NextGenSoftware-Libraries