Terminal.Gui
2.0.0-dev.1820
See the version list below for details.
dotnet add package Terminal.Gui --version 2.0.0-dev.1820
NuGet\Install-Package Terminal.Gui -Version 2.0.0-dev.1820
<PackageReference Include="Terminal.Gui" Version="2.0.0-dev.1820" />
paket add Terminal.Gui --version 2.0.0-dev.1820
#r "nuget: Terminal.Gui, 2.0.0-dev.1820"
// Install Terminal.Gui as a Cake Addin #addin nuget:?package=Terminal.Gui&version=2.0.0-dev.1820&prerelease // Install Terminal.Gui as a Cake Tool #tool nuget:?package=Terminal.Gui&version=2.0.0-dev.1820&prerelease
The current, stable, release of Terminal.Gui is v1.x. It is stable, rich, and broadly used. The team is now focused on designing and building a significant upgrade we're referring to as v2
. Therefore:
v1
is now in maintenance mode, meaning we will accept PRs for v1.x (thedevelop
branch) only for issues impacting existing functionality.- All new development happens on the
v2_develop
branch. See the V2 discussion here. - Developers are encouraged to continue building on v1.x until we announce
v2
is stable.
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
Showcase & Examples
- UI Catalog - The UI Catalog project provides an easy to use and extend sample illustrating the capabilities of Terminal.Gui. Run
dotnet run --project UICatalog
to run the UI Catalog. - C# Example - Run
dotnet run
in theExample
directory to run the C# Example. - F# Example - An example showing how to build a Terminal.Gui app using F#.
- Reactive Example - A sample app that shows how to use
System.Reactive
andReactiveUI
withTerminal.Gui
. The app uses the MVVM architecture that may seem familiar to folks coming from WPF, Xamarin Forms, UWP, Avalonia, or Windows Forms. In this app, we implement the data bindings using ReactiveUIWhenAnyValue
syntax and Pharmacist — a tool that converts all events in a NuGet package into observable wrappers. - PowerShell's
Out-ConsoleGridView
-OCGV
sends the output from a command to an interactive table. - F7History - Graphical Command History for PowerShell (built on PowerShell's
Out-ConsoleGridView
). - PoshRedisViewer - A compact Redis viewer module for PowerShell written in F#.
- PoshDotnetDumpAnalyzeViewer - dotnet-dump UI module for PowerShell.
- TerminalGuiDesigner - Cross platform view designer for building Terminal.Gui applications.
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)
- System.IO.Abstractions (>= 21.0.2)
- System.Text.Json (>= 8.0.3)
- Wcwidth (>= 2.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 (17)
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)
|