https://github.com/tui-cs/Terminal.Gui
Cross Platform Terminal UI toolkit for .NET
https://github.com/tui-cs/Terminal.Gui
console console-application cross-platform csharp curses dotnet terminal terminal-based terminal-ui tui
Last synced: about 4 hours ago
JSON representation
Cross Platform Terminal UI toolkit for .NET
- Host: GitHub
- URL: https://github.com/tui-cs/Terminal.Gui
- Owner: tui-cs
- License: mit
- Created: 2017-12-11T03:23:45.000Z (over 8 years ago)
- Default Branch: develop
- Last Pushed: 2026-06-23T18:12:09.000Z (4 days ago)
- Last Synced: 2026-06-23T18:27:50.248Z (4 days ago)
- Topics: console, console-application, cross-platform, csharp, curses, dotnet, terminal, terminal-based, terminal-ui, tui
- Language: C#
- Homepage: https://gui-cs.github.io/Terminal.Gui/
- Size: 188 MB
- Stars: 11,080
- Watchers: 142
- Forks: 778
- Open Issues: 56
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
- Agents: AGENTS.md
Awesome Lists containing this project
README
[](https://codecov.io/gh/tui-cs/Terminal.Gui)
[](https://www.nuget.org/packages/Terminal.Gui)
# Terminal.Gui
Cross-platform UI toolkit for building sophisticated terminal UI (TUI) applications on Windows, macOS, and Linux/Unix.
## 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](https://tui-cs.github.io/Terminal.Gui/docs/views) for available controls and [What's New in v2](https://tui-cs.github.io/Terminal.Gui/docs/newinv2) for architectural improvements.
# Quick Start
Install the [Terminal.Gui.Templates](https://github.com/tui-cs/Terminal.Gui.templates), create a new TUI app, and run it:
```powershell
dotnet new install Terminal.Gui.Templates
dotnet new tui-simple -n myproj
cd myproj
dotnet run
```
Run the comprehensive [UI Catalog](Examples/UICatalog) demo to explore all controls:
```powershell
dotnet run --project Examples/UICatalog/UICatalog.csproj
```
# Simple Example
```csharp
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](Examples/README.md) for details about the in-repository examples and links to the moved examples repository.
# Showcase
See the [Showcase](https://tui-cs.github.io/Terminal.Gui/docs/showcase) for applications built with Terminal.Gui.
# Documentation
Comprehensive documentation is at [tui-cs.github.io/Terminal.Gui](https://tui-cs.github.io/Terminal.Gui).
## Getting Started
- **[Getting Started Guide](https://tui-cs.github.io/Terminal.Gui/docs/getting-started)** - First Terminal.Gui application
- **[API Reference](https://tui-cs.github.io/Terminal.Gui/api/Terminal.Gui.App.html)** - Complete API documentation
- **[What's New in v2](https://tui-cs.github.io/Terminal.Gui/docs/newinv2)** - New features and improvements
## Migration & Deep Dives
- **[Migrating from v1 to v2](https://tui-cs.github.io/Terminal.Gui/docs/migratingfromv1)** - Complete migration guide
- **[Application Architecture](https://tui-cs.github.io/Terminal.Gui/docs/application)** - Instance-based model and IRunnable pattern
- **[Layout System](https://tui-cs.github.io/Terminal.Gui/docs/layout)** - Positioning, sizing, and adornments
- **[Keyboard Handling](https://tui-cs.github.io/Terminal.Gui/docs/keyboard)** - Key bindings and commands
- **[View Documentation](https://tui-cs.github.io/Terminal.Gui/docs/View)** - View hierarchy and lifecycle
- **[Configuration](https://tui-cs.github.io/Terminal.Gui/docs/config)** - Themes and persistent settings
See the [documentation index](https://tui-cs.github.io/Terminal.Gui/docs/index) for all topics.
# Installing
```powershell
dotnet add package Terminal.Gui
```
Or use the [Terminal.Gui.Templates](https://github.com/tui-cs/Terminal.Gui.templates):
```powershell
dotnet new install Terminal.Gui.Templates
```
### Powered by
[](https://jb.gg/OpenSource)
# Contributing
Contributions welcome! See [CONTRIBUTING.md](CONTRIBUTING.md).
# History
See [tui-cs](https://github.com/tui-cs/) for project history and origins.