Terminal.Gui README

The project's README from github.com/tui-cs/Terminal.Gui. As one markdown file: README.md.

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

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.

Terminal.Gui (tui-cs/Terminal.Gui)

Searching Database…

11.3K ·GitHub
Terminal.Gui
Что это такое?Terminal.Gui — кроссплатформенный набор инструментов для создания сложных TUI-приложений (с текстовым интерфейсом в терминале) на .NET, которые одинаково работают в Windows, macOS и Linux/Unix.
Это фреймворк или библиотека, которую я просто вызываю?Это фреймворк/библиотека пользовательского интерфейса для .NET: вы создаёте новое приложение из его шаблона проекта, затем собираете интерфейс из встроенных View (виджетов), а движок компоновки сам занимается размерами и расположением элементов.
Как запустить приложение на Terminal.Gui?Установите пакет Terminal.Gui.Templates, создайте новое TUI-приложение из шаблона и запустите его; также можно запустить демо UI Catalog, чтобы посмотреть все доступные элементы управления.
Нужно ли что-то, кроме .NET SDK, чтобы собирать с этой библиотекой?Это библиотека на .NET (C#), которая распространяется через шаблон проекта dotnet и пакет NuGet, поэтому достаточно установленного .NET SDK; внешние среды выполнения или нативные зависимости не указаны.
Можно ли просто перейти на v2 без доработок в приложениях на v1?Нет — в README есть отдельное руководство по переходу с v1 на v2, что говорит о том, что v2 принесла архитектурные изменения (например, модель Application на основе экземпляров), которые полностью не совместимы с v1 назад.
Кто будет этим пользоваться и для каких приложений?Разработчики, которые создают CLI/консольные инструменты на .NET и хотят богатые интерактивные интерфейсы, например инструменты с прокруткой прямо в терминале в стиле Claude Code, Copilot или Codex CLI, либо полноэкранные терминальные приложения с текстовыми редакторами, файловыми браузерами и мастерами.
Какие виджеты есть из коробки?Текстовые редакторы, кнопки, чекбоксы, деревья, таблицы, отрисовка markdown, меню, селекторы, диаграммы, графики, индикаторы прогресса, выбор цвета с поддержкой TrueColor и браузеры файлов и каталогов с поддержкой Nerd Font.
Поддерживается ли мышь или только клавиатура?Оба варианта: библиотека оптимизирована для работы только с клавиатурой, но также имеет полную поддержку мыши.
Можно ли настроить внешний вид и оформление?Да, темы, цвета, сочетания клавиш и настройки полностью настраиваются и могут сохраняться.
Где посмотреть реальные приложения, созданные на этой библиотеке?В README есть ссылка на страницу Showcase со списком приложений, созданных с помощью Terminal.Gui.
What are similar projects?spectre.console, kakoune, spotatui, ratatui, bubbletea, runtime, MonoGame, Avalonia
Which topics is it in?terminal-based, terminal-ui, console, dotnet, c#, csharp, tui, framework, gui, terminal, library, cross-platform
Creator
tui-cs
Size
195.7 MB
Stars
11.3K
Updated
CommitOct 15Releasev2.5.0Sep 11
Age
8y
Commits · 90 Days