x-skywalker / spectre.console

A .NET library that makes it easier to create beautiful console applications.

Spectre.Console

A .NET library that makes it easier to create beautiful, cross platform, console applications.
It is heavily inspired by the excellent Rich library for Python. For detailed usage instructions, please refer to the documentation at https://spectreconsole.net/.

Table of Contents

1. Features
2. Installing
3. Documentation
4. Examples
5. Sponsors
6. Code of Conduct
7. .NET Foundation
8. License

Features

• Written with unit testing in mind.
• Supports tables, grids, panels, and a rich inspired markup language.
• Supports the most common SRG parameters when it comes to text styling such as bold, dim, italic, underline, strikethrough, and blinking text.
• Supports 3/4/8/24-bit colors in the terminal.
  The library will detect the capabilities of the current terminal and downgrade colors as needed.

Installing

The fastest way of getting started using Spectre.Console is to install the NuGet package.

dotnet add package Spectre.Console

Documentation

The documentation for Spectre.Console can be found at https://spectreconsole.net/

Examples

To see Spectre.Console in action, install the dotnet-example global tool.

> dotnet tool restore

Now you can list available examples in this repository:

> dotnet example

And to run an example:

> dotnet example tables

Sponsors

The following people are sponsoring Spectre.Console to show their support and to ensure the longevity of the project.

• Rodney Littles II
• Martin Björkström
• Dave Glick
• Kim Gunnarsson
• Andrew McClenaghan
• C. Augusto Proiete
• Viktor Elofsson
• Steven Knox
• David Pendray
• Elmah.io
• Tom Kerkhove

We really appreciate it.
Thank you very much!

Code of Conduct

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. For more information see the .NET Foundation Code of Conduct.

.NET Foundation

This project is supported by the .NET Foundation.

License

Copyright © Patrik Svensson, Phil Scott, Nils Andresen

Spectre.Console is provided as-is under the MIT license. For more information see LICENSE.

• SixLabors.ImageSharp, a library which Spectre.Console relies upon, is licensed under Apache 2.0 when distributed as part of Spectre.Console. The Six Labors Split License covers all other usage, see: https://github.com/SixLabors/ImageSharp/blob/master/LICENSE