Skip to content

spectreconsole/spectre.console

Repository files navigation

Spectre.Console

Spectre.Console NuGet VersionSpectre.Console CLI NuGet VersionNetlify Status

A.NET library that makes it easier to create beautiful, cross platform, console applications.
It is heavily inspired by the excellent Python library,Rich.Detailed instructions for usingSpectre.Consoleare located on the project website,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

  • Supports tables, grids, panels, and aRichinspired 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.
  • Written with unit testing in mind.

Example

Important Notices

Important

We use theTop Issues Dashboardfor tracking community demand. Please upvote 👍 the issues and pull requests you are interested in.

Installing

The fastest way of getting started usingSpectre.Consoleis to install the NuGet package.

dotnetaddpackage Spectre.Console

Documentation

The documentation forSpectre.Consolecan be found at https://spectreconsole.net

Examples

To seeSpectre.Consolein action, please see the examples repository.

Sponsors

The following people aresponsoring Spectre.Consoleto show their support and to ensure the longevity of the project.

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, Cédric Luthi, Frank Ray

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