Terminal.Gui
2.0.0-prealpha.216
See the version list below for details.
dotnet add package Terminal.Gui --version 2.0.0-prealpha.216
NuGet\Install-Package Terminal.Gui -Version 2.0.0-prealpha.216
<PackageReference Include="Terminal.Gui" Version="2.0.0-prealpha.216" />
paket add Terminal.Gui --version 2.0.0-prealpha.216
#r "nuget: Terminal.Gui, 2.0.0-prealpha.216"
// Install Terminal.Gui as a Cake Addin #addin nuget:?package=Terminal.Gui&version=2.0.0-prealpha.216&prerelease // Install Terminal.Gui as a Cake Tool #tool nuget:?package=Terminal.Gui&version=2.0.0-prealpha.216&prerelease
- The current, stable, release of Terminal.Gui v1 is
.
- The current
prealpha
release of Terminal.Gui v2 can be found on Nuget. - Developers starting new TUI projects are encouraged to target
v2
. The API is signifcantly changed, and significantly improved. There will be breaking changes in the API before Beta, but the core API is stable. v1
is in maintenance mode and we will only accept PRs for issues impacting existing functionality.
Terminal.Gui: A toolkit for building rich console apps for .NET, .NET Core, and Mono that works on Windows, the Mac, and Linux/Unix.
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
Documentation
The Documentation matches the most recent Nuget release from the v2_develop
branch. The documentation for v1 is here: ()
See the Terminal.Gui/
README for an overview of how the library is structured.
Showcase & Examples
Terminal.Gui can be used with any .Net language to create feature rich and robust applications.
Showcase is a place where you can find all kind of projects from simple examples to advanced real world apps that fully utilize capabilities of the toolkit.
The team is looking forward to seeing new amazing projects made by the community to be added there!
Sample Usage in C#
The following example shows a basic Terminal.Gui application in C#:
// This is a simple example application. For the full range of functionality
// see the UICatalog project
// A simple Terminal.Gui example in C# - using C# 9.0 Top-level statements
using System;
using Terminal.Gui;
Application.Run<ExampleWindow> ().Dispose ();
// Before the application exits, reset Terminal.Gui for clean shutdown
Application.Shutdown ();
// To see this output on the screen it must be done after shutdown,
// which restores the previous screen.
Console.WriteLine ($@"Username: {ExampleWindow.UserName}");
// Defines a top-level window with border and title
public class ExampleWindow : Window
{
public static string UserName;
public ExampleWindow ()
{
Title = $"Example App ({Application.QuitKey} to quit)";
// Create input components and labels
var usernameLabel = new Label { Text = "Username:" };
var userNameText = new TextField
{
// Position text field adjacent to the label
X = Pos.Right (usernameLabel) + 1,
// Fill remaining horizontal space
Width = Dim.Fill ()
};
var passwordLabel = new Label
{
Text = "Password:", X = Pos.Left (usernameLabel), Y = Pos.Bottom (usernameLabel) + 1
};
var passwordText = new TextField
{
Secret = true,
// align with the text box above
X = Pos.Left (userNameText),
Y = Pos.Top (passwordLabel),
Width = Dim.Fill ()
};
// Create login button
var btnLogin = new Button
{
Text = "Login",
Y = Pos.Bottom (passwordLabel) + 1,
// center the login button horizontally
X = Pos.Center (),
IsDefault = true
};
// When login button is clicked display a message popup
btnLogin.Accept += (s, e) =>
{
if (userNameText.Text == "admin" && passwordText.Text == "password")
{
MessageBox.Query ("Logging In", "Login Successful", "Ok");
UserName = userNameText.Text;
Application.RequestStop ();
}
else
{
MessageBox.ErrorQuery ("Logging In", "Incorrect username or password", "Ok");
}
};
// Add the views to the Window
Add (usernameLabel, userNameText, passwordLabel, passwordText, btnLogin);
}
}
When run the application looks as follows:
Installing
Use NuGet to install the Terminal.Gui
NuGet package: https://www.nuget.org/packages/Terminal.Gui
Installation in .NET Core Projects
To install Terminal.Gui into a .NET Core project, use the dotnet
CLI tool with this command.
dotnet add package Terminal.Gui
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.
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. |
-
net8.0
- ColorHelper (>= 1.8.1 && < 2.0.0)
- System.IO.Abstractions (>= 21.0.22 && < 22.0.0)
- System.Text.Json (>= 8.0.4 && < 9.0.0)
- Wcwidth (>= 2.0.0 && < 3.0.0)
NuGet packages (22)
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 5 popular GitHub repositories that depend on Terminal.Gui:
Repository | Stars |
---|---|
gui-cs/Terminal.Gui
Cross Platform Terminal UI toolkit for .NET
|
|
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
|
|
Decimation/SmartImage
Reverse image search tool (SauceNao, IQDB, Ascii2D, trace.moe, and more)
|
Version | Downloads | Last updated |
---|---|---|
2.0.0-v2-develop.2329 | 0 | 8/31/2024 |
2.0.0-v2-develop.2324 | 0 | 8/31/2024 |
2.0.0-v2-develop.2321 | 0 | 8/31/2024 |
2.0.0-v2-develop.2320 | 59 | 8/29/2024 |
2.0.0-v2-develop.2214 | 48 | 8/28/2024 |
2.0.0-v2-develop.2211 | 37 | 8/28/2024 |
2.0.0-v2-develop.2209 | 34 | 8/28/2024 |
2.0.0-v2-develop.2203 | 475 | 8/23/2024 |
2.0.0-v2-develop.2202 | 35 | 8/23/2024 |
2.0.0-v2-develop.2201 | 40 | 8/23/2024 |
2.0.0-v2-develop.2189 | 276 | 8/19/2024 |
2.0.0-v2-develop.2169 | 58 | 8/17/2024 |
2.0.0-v2-develop.2168 | 102 | 8/14/2024 |
2.0.0-v2-develop.2167 | 49 | 8/13/2024 |
2.0.0-v2-develop.2166 | 57 | 8/12/2024 |
2.0.0-v2-develop.2165 | 39 | 8/10/2024 |
2.0.0-v2-develop.2164 | 58 | 8/6/2024 |
2.0.0-v2-develop.2163 | 26 | 8/6/2024 |
2.0.0-prealpha.216 | 635 | 8/6/2024 |
1.18.0-pre.35 | 52 | 7/9/2024 |
1.18.0-pre.34 | 84 | 7/3/2024 |
1.18.0-pre.30 | 44 | 7/3/2024 |
1.18.0-pre.28 | 40 | 7/3/2024 |
1.18.0-pre.26 | 41 | 6/26/2024 |
1.18.0-pre.20 | 35 | 6/26/2024 |
1.18.0-pre.17 | 39 | 6/21/2024 |
1.18.0-pre.15 | 43 | 6/18/2024 |
1.18.0-pre.13 | 43 | 6/9/2024 |
1.18.0-pre.11 | 40 | 6/9/2024 |
1.18.0-pre.4 | 55 | 6/9/2024 |
1.17.1 | 6,589 | 7/11/2024 |
1.16.0 | 19,108 | 3/16/2024 |
1.15.1 | 22,550 | 1/22/2024 |
1.14.2-pre.177 | 34 | 8/12/2024 |
1.14.2-pre.176 | 34 | 7/11/2024 |
1.14.1 | 33,884 | 10/30/2023 |
1.13.4 | 1,171 | 7/19/2023 |
1.7.1 | 1,180 | 8/1/2022 |
1.6.3 | 948 | 5/27/2022 |
1.2.0 | 1,407 | 8/24/2021 |
1.1.0 | 600 | 5/16/2021 |