Terminal.Gui
2.0.0-develop.4610
See the version list below for details.
dotnet add package Terminal.Gui --version 2.0.0-develop.4610
NuGet\Install-Package Terminal.Gui -Version 2.0.0-develop.4610
<PackageReference Include="Terminal.Gui" Version="2.0.0-develop.4610" />
<PackageVersion Include="Terminal.Gui" Version="2.0.0-develop.4610" />
<PackageReference Include="Terminal.Gui" />
paket add Terminal.Gui --version 2.0.0-develop.4610
#r "nuget: Terminal.Gui, 2.0.0-develop.4610"
#:package Terminal.Gui@2.0.0-develop.4610
#addin nuget:?package=Terminal.Gui&version=2.0.0-develop.4610&prerelease
#tool nuget:?package=Terminal.Gui&version=2.0.0-develop.4610&prerelease
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 for complete contribution guidelines.
Debates on architecture and design can be found in Issues tagged with design.
History
See gui-cs for how this project came to be.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
-
net8.0
- ColorHelper (>= 1.8.1 && < 2.0.0)
- JetBrains.Annotations (>= 2025.2.2)
- Microsoft.Extensions.Logging.Abstractions (>= 9.0.0 && < 10.0.0)
- System.IO.Abstractions (>= 22.0.16 && < 23.0.0)
- Wcwidth (>= 3.0.0)
NuGet packages (26)
Showing the top 5 NuGet packages that depend on Terminal.Gui:
| Package | Downloads |
|---|---|
|
HIC.RDMP.Plugin
Core package for plugin development |
|
|
Carbon.Kit
Provides interfaces, abstractions and common functions which is the essence of Carbon Kit. |
|
|
FluiTec.AppFx.Console
Package Description |
|
|
M5x.TermUi
Package Description |
|
|
Terminal.Gui.Elmish
An elmish wrapper around Miguel de Icaza's 'Gui.cs' https://github.com/migueldeicaza/gui.cs including F# Feliz-like like view DSL. |
GitHub repositories (16)
Showing the top 16 popular GitHub repositories that depend on Terminal.Gui:
| Repository | Stars |
|---|---|
|
awaescher/RepoZ
👨💻 A zero-conf git repository hub for Windows and macOS with Windows Explorer- & CLI-enhancements
|
|
|
PowerShell/ConsoleGuiTools
Modules that mix PowerShell and GUIs/CUIs!
|
|
|
paillave/Etl.Net
Mass processing data with a complete ETL for .net developers
|
|
|
bjorkstromm/depends
Tool for generating dependency trees for .NET projects
|
|
|
gui-cs/TerminalGuiDesigner
Forms Designer for Terminal.Gui (aka gui.cs)
|
|
|
NicolasConstant/BirdsiteLive
An ethical bridge from Twitter
|
|
|
CCob/Volumiser
|
|
|
YSGStudyHards/DotNetExercises
⚔【DotNetGuide专栏C#/.NET/.NET Core编程技巧练习集】C#/.NET/.NET Core编程常用语法、算法、技巧、中间件、类库、工作业务实操练习集，配套详细的文章教程和代码示例，助力快速掌握C#/.NET/.NET Core中各种编程常用语法、算法、技巧、中间件、类库、工作业务实操等等。
|
|
|
Texnomic/SecureDNS
Secure, Modern, Fully-Featured, All-In-One Cross-Architecture & Cross-Platform DNS Server Using .NET 8.0
|
|
|
PKISharp/ACMESharpCore
An ACME v2 client library for .NET Standard (Let's Encrypt)
|
|
|
ironmansoftware/psedit
A terminal-based editor for PowerShell
|
|
|
reactiveui/ReactiveMvvm
Cross-platform ReactiveUI sample app built for a talk at MSK .NET conf.
|
|
|
migueldeicaza/XtermSharp
XTerm emulator as a .NET library
|
|
|
mbbsemu/MBBSEmu
The MajorBBS Emulation Project is an Open Source, Cross-Platform emulator for easily running The MajorBBS & Worldgroup Modules
|
|
|
Draco-lang/Compiler
The compiler repository for the Draco programming language.
|
|
|
henrikstengaard/hstwb-installer
A set of scripts to automate installation of Amiga OS, Kickstart roms and packages to new or existing Amiga HDF files
|