Terminal.Gui

The premier toolkit for building rich console apps for Windows, the Mac, and Linux/Unix.

• The current, stable, release of Terminal.Gui v1 is .

⚠️ Note:
v1 is in maintenance mode and we will only accept PRs for issues impacting existing functionality.

• The current prealpha release of Terminal.Gui v2 is

⚠️ Note:
Developers starting new TUI projects are encouraged to target v2. The API is significantly changed, and significantly improved. There will be breaking changes in the API before Beta, but the core API is stable.

Quick Start

Paste these commands into your favorite terminal on Windows, Mac, or Linux. This will install the Terminal.Gui.Templates, create a new "Hello World" TUI app, and run it.

(Press CTRL-Q to exit the app)

dotnet new --install Terminal.Gui.templates
dotnet new tui -n myproj
cd myproj
dotnet run

To run the UICatalog demo app that shows all the controls and features of the toolkit, use the following command:

dotnet run --project Examples/UICatalog/UICatalog.csproj

There is also a visual designer (uses Terminal.Gui itself).

Documentation

The full developer documentation for Terminal.Gui is available at gui-cs.github.io/Terminal.GuiV2Docs.

Getting Started

• Getting Started - Quick start guide to create your first Terminal.Gui application
• Migrating from v1 to v2 - Complete guide for upgrading existing applications
• What's New in v2 - Overview of new features and improvements

API Reference

For detailed API documentation, see the API Reference.

Installing

Use NuGet to install the Terminal.Gui NuGet package:

v2 Pre-Alpha

(Infrequently updated, but stable enough for production use)

dotnet add package Terminal.Gui --version "2.0.0-prealpha.*"

v2 Develop

(Frequently updated, but may have breaking changes)

dotnet add package Terminal.Gui --version "2.0.0-develop.*"

Legacy v1

dotnet add package Terminal.Gui

Or, you can use the Terminal.Gui.Templates.

Contributing

See CONTRIBUTING.md.

Debates on architecture and design can be found in Issues tagged with design.

History

See gui-cs for how this project came to be.