Terminal.Gui.v2desktop
2024.5.15.1
dotnet add package Terminal.Gui.v2desktop --version 2024.5.15.1
NuGet\Install-Package Terminal.Gui.v2desktop -Version 2024.5.15.1
<PackageReference Include="Terminal.Gui.v2desktop" Version="2024.5.15.1" />
paket add Terminal.Gui.v2desktop --version 2024.5.15.1
#r "nuget: Terminal.Gui.v2desktop, 2024.5.15.1"
// Install Terminal.Gui.v2desktop as a Cake Addin #addin nuget:?package=Terminal.Gui.v2desktop&version=2024.5.15.1 // Install Terminal.Gui.v2desktop as a Cake Tool #tool nuget:?package=Terminal.Gui.v2desktop&version=2024.5.15.1
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
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
2024.5.15.1 | 144 | 5/15/2024 |
1.0.0 | 86 | 5/15/2024 |