496b6b869f
* Initial plan * Optimize CI workflows to share build artifacts across test jobs Co-authored-by: tig <585482+tig@users.noreply.github.com> * Add documentation comments to workflow files Co-authored-by: tig <585482+tig@users.noreply.github.com> * Add clarifying comments to integration-tests workflow Co-authored-by: tig <585482+tig@users.noreply.github.com> * Refactor to use single centralized build workflow Co-authored-by: tig <585482+tig@users.noreply.github.com> * Fix Release build by adding AOT and SelfContained project restore Co-authored-by: tig <585482+tig@users.noreply.github.com> * Fix Release build by building Terminal.Gui first before AOT projects Co-authored-by: tig <585482+tig@users.noreply.github.com> * Fix Release build by packing Terminal.Gui and building AOT projects separately Co-authored-by: tig <585482+tig@users.noreply.github.com> * Remove redundant build-release.yml workflow Co-authored-by: tig <585482+tig@users.noreply.github.com> * Suppress Obsolete warnings (0618;0612) in build workflow Co-authored-by: tig <585482+tig@users.noreply.github.com> * Fix NoWarn parameter by quoting to prevent shell interpretation Co-authored-by: tig <585482+tig@users.noreply.github.com> * Fix NoWarn parameter syntax - use comma separator and /p: prefix Co-authored-by: tig <585482+tig@users.noreply.github.com> * Fix NoWarn parameter with URL-encoded semicolon and add documentation Co-authored-by: tig <585482+tig@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: tig <585482+tig@users.noreply.github.com> Co-authored-by: Tig <tig@users.noreply.github.com>
Terminal.Gui v2
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:
v1is in maintenance mode and we will only accept PRs for issues impacting existing functionality.
- The current
Alpharelease of Terminal.Gui v2 is
⚠️ Note:
Developers starting new TUI projects are encouraged to targetv2 Alpha. 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.Gui.
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 Alpha
(Infrequently updated, but stable enough for production use)
dotnet add package Terminal.Gui --version "2.0.0-alpha.*"
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 --version "1.*
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.