Terminal.Gui 2.5.0

There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package Terminal.Gui --version 2.5.0
                    
NuGet\Install-Package Terminal.Gui -Version 2.5.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.

                    
Directory.Packages.props

                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Terminal.Gui --version 2.5.0
                    
#r "nuget: Terminal.Gui, 2.5.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Terminal.Gui@2.5.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Terminal.Gui&version=2.5.0
                    
Install as a Cake Addin
#tool nuget:?package=Terminal.Gui&version=2.5.0
                    
Install as a Cake Tool

NuGet Version Bugs codecov Downloads

Terminal.Gui

Cross-platform UI toolkit for building sophisticated terminal UI (TUI) applications on Windows, macOS, and Linux/Unix.

Terminal.Gui — cross-platform TUI toolkit for .NET. Build full-featured terminal UIs with menus, forms, tables, charts, wizards and file dialogs. +11k stars, +50 built-in views, +1.7M downloads, TrueColor with Unicode and mouse — Windows / macOS / Linux, MIT-licensed.

Terminal.Gui enables building sophisticated console applications with modern UIs

  • Responsive TUI - Easy to use, innovative, layout system enables console apps as responsive as any responsive web page.
  • Performant and Scalable - Built for modern TUIs - fast, double-buffering-based rendering; Tables and Tree Views scale to infinite elements with sorting and filtering.
  • Keyboard First; Mouse First Too - Optimized for TUI experiences where the user's hands never need to leave the keyboard; full mouse support too.
  • Rich Built-in Widgets (Views) - Text editors, buttons, checkboxes, trees, tables, markdown, linear ranges, menus, selectors, and more.
  • Visualizations - Charts, graphs, progress indicators, and color pickers with TrueColor support.
  • Text Editors - Full-featured text editing with clipboard, undo/redo, and Unicode support
  • Fully Configurable - Themes, colors, key bindings, and settings are all customizable and persistable.
  • File Management - File and directory browsers with search and filtering, supporting Nerdfonts and coloring.
  • Wizards and Multi-Step Processes - Guided workflows with navigation and validation.
  • Cross-Platform - Consistent experience on Windows, macOS, and Linux.
  • Apps Work In-line or Full Screen - Build CLI tools like Claude Code/Copilot/Codex CLI that scroll with the terminal (in-line) or full screen.

See the Views Overview for available controls and What's New in v2 for architectural improvements.

Quick Start

Install the Terminal.Gui.Templates, create a new TUI app, and run it:

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

Run the comprehensive UI Catalog demo to explore all controls:

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

Simple Example

using Terminal.Gui.App;
using Terminal.Gui.ViewBase;
using Terminal.Gui.Views;

using IApplication app = Application.Create ();
app.Init ();

using Window window = new () { Title = "Hello World (Esc to quit)" };
Label label = new ()
{
    Text = "Hello, Terminal.Gui v2!",
    X = Pos.Center (),
    Y = Pos.Center ()
};
window.Add (label);

app.Run (window);

See Examples/README.md for details about the in-repository examples and links to the moved examples repository.

Showcase

See the Showcase for applications built with Terminal.Gui.

Documentation

Comprehensive documentation is at tui-cs.github.io/Terminal.Gui.

Getting Started

Migration & Deep Dives

See the documentation index for all topics.

Installing

dotnet add package Terminal.Gui

Or use the Terminal.Gui.Templates:

dotnet new install Terminal.Gui.Templates

Powered by

JetBrains logo.

Contributing

Contributions welcome! See CONTRIBUTING.md.

History

See tui-cs for project history and origins.

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (35)

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

Terminal.Gui.Editor

Full-featured text editor View for Terminal.Gui — rope-backed document model, multi-caret, folding, search, undo/redo, optional TextMate highlighting. Adapted from AvaloniaEdit.

M5x.TermUi

Package Description

GitHub repositories (25)

Showing the top 20 popular GitHub repositories that depend on Terminal.Gui:

Repository Stars
rnwood/smtp4dev
smtp4dev - the fake smtp email server for development and testing
StartupHakk/OpenMonoAgent.ai
(BETA) AI shouldn't have a meter. Unlimited tokens. Forever. Your machine. Your agent. Use it from anywhere. Terminal-native coding agent powered by local LLMs — 100% open source, free forever, and installed with a single command. Proudly built on C#/.NET, because AI tooling should be infrastructure, not a subscription.
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
Krypton-Suite/Standard-Toolkit
An update to Component factory's krypton toolkit to support .NET Framework 4.6.2 - 4.8.1 to .NET 8 - 10
tui-cs/TerminalGuiDesigner
Forms Designer for Terminal.Gui (aka gui.cs)
YSGStudyHards/DotNetExercises
⚔【DotNetGuide专栏C#/.NET/.NET Core编程技巧练习集】C#/.NET/.NET Core编程常用语法、算法、技巧、中间件、类库、工作业务实操练习集,配套详细的文章教程和代码示例,助力快速掌握C#/.NET/.NET Core中各种编程常用语法、算法、技巧、中间件、类库、工作业务实操等等。
NicolasConstant/BirdsiteLive
An ethical bridge from Twitter
CCob/Volumiser
Texnomic/SecureDNS
Secure, Modern, Fully-Featured, All-In-One Cross-Architecture & Cross-Platform DNS Server Using .NET 10
PKISharp/ACMESharpCore
An ACME v2 client library for .NET Standard (Let's Encrypt)
ironmansoftware/psedit
A terminal-based editor for PowerShell
Log2n-io/Typhon
A microsecond-latency ACID database engine with a native Entity-Component-System data model, built for real-time systems.
migueldeicaza/XtermSharp
XTerm emulator as a .NET library
reactiveui/ReactiveMvvm
A sample application showing one set of ReactiveUI view models shared across many .NET UI frameworks. Includes front ends for Avalonia, .NET MAUI, WPF, Windows Forms, Blazor and Terminal.Gui.
timkicker/podliner
Podcasts in any terminal. Fast, clean, offline.
mbbsemu/MBBSEmu
The MajorBBS Emulation Project is an Open Source, Cross-Platform emulator for easily running The MajorBBS & Worldgroup Modules
SquareWaveSystems/opcilloscope
Browse and monitor OPC UA servers from your terminal. Lightweight, cross-platform, keyboard and mouse friendly.
Version Downloads Last Updated
2.6.0-develop.61 587 9/3/2026
2.5.1-develop.72 29 10/5/2026
2.5.1-develop.51 48 10/3/2026
2.5.1-develop.44 175 9/28/2026
2.5.1-develop.43 57 9/28/2026
2.5.1-develop.42 58 9/28/2026
2.5.1-develop.41 75 9/21/2026
2.5.1-develop.40 71 9/21/2026
2.5.1-develop.39 67 9/16/2026
2.5.1-develop.38 81 9/15/2026
2.5.1-develop.36 67 9/14/2026
2.5.1-develop.34 72 9/14/2026
2.5.1-develop.32 70 9/14/2026
2.5.1-develop.30 69 9/14/2026
2.5.1-develop.28 69 9/14/2026
2.5.1-develop.26 69 9/14/2026
2.5.1-develop.11 66 9/14/2026
2.5.1-develop.5 71 9/14/2026
2.5.1-develop.1 85 9/11/2026
2.5.0 37,751 9/11/2026
Loading failed