spectre.console README

The project's README from github.com/spectreconsole/spectre.console. As one markdown file: README.md.

Spectre.Console

Spectre.Console NuGet Version

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 using Spectre.Console are located on the project website, https://spectreconsole.net

Table of Contents

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

Features

Example

Important Notices

[!IMPORTANT]
We use the Top Issues Dashboard for tracking community demand. Please upvote :+1: the issues and pull requests you are interested in.

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, please see the examples repository.

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.

Translations

License

Copyright © Patrik Svensson, Phil Scott, Nils Andresen, Cédric Luthi

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

spectre.console (spectreconsole/spectre.console)

Searching Database…

What is this?Spectre.Console is a .NET library that makes it easier to build beautiful, cross-platform console applications, with tables, panels, markup, and rich text styling.
Is it a framework or a library?It is a library you add to your own .NET console app, not a standalone application or full framework.
How do I add it to a project?Install the Spectre.Console NuGet package into your .NET project; that's the fastest way to get started.
Do I need anything besides the .NET SDK?No extra tools are required beyond the NuGet package itself; it does pull in SixLabors.ImageSharp internally for certain features.
Will my colors look right in any terminal?The library auto-detects your terminal's capabilities and downgrades colors as needed, so output adapts to 3/4/8/24-bit color support rather than guaranteeing full fidelity everywhere.
Does it work the same on Windows, macOS, and Linux?Yes, it's designed to be cross-platform for console apps on any OS that runs .NET.
What inspired Spectre.Console's design?It was heavily inspired by the popular Python library Rich, bringing a similar rich-text markup and layout approach to .NET console apps.
What UI elements can I build with it?Tables, grids, panels, and other visual components, plus a Rich-inspired markup language for styling text with bold, italic, underline, strikethrough, and blinking effects.
Where can I see it in action before using it?There's a separate examples repository showcasing Spectre.Console features in real console applications.
Is the project actively maintained?Yes, it's supported by the .NET Foundation and uses a Top Issues Dashboard to track community-requested features and fixes.
What are similar projects?Terminal.Gui, efcore, rich, Cpp2IL, ratatui, uno, Avalonia, roslyn
Size
16.1 MB
Stars
11.7K
Updated
CommitOct 05
Age
6y
Commits · 90 Days