暂无描述

copilot-swe-agent[bot] 1dd0978287 Document MockConsoleDriver purpose and verify naming consistency 1 月之前
.devcontainer 651ee21ba5 Fixes #2323. The devcontainer.json settings isn't work with the current develop branch. 2 年之前
.github afa7da3ae5 Fixes #4078 - Implement automatic URL detection with OSC 8 hyperlinks at driver level (#4340) 1 月之前
Examples a0979368cb Fixes #4125. Remove legacy MainLoop infrastructure (#4343) 1 月之前
Scripts fe18c81dc9 Fixed gitversion 9 月之前
Terminal.Gui 0132aebd77 Add comprehensive documentation for FakeDriver testing infrastructure 1 月之前
Terminal.Gui.Analyzers 3a645191db Fixes #4170 - Added analyzer that flags when user does not have `Handled=true` (#4182) 5 月之前
Terminal.Gui.Analyzers.Tests a3399776b7 Fixes nuget packages with vulnerabilities (#4218) 4 月之前
Tests 1dd0978287 Document MockConsoleDriver purpose and verify naming consistency 1 月之前
docfx a0979368cb Fixes #4125. Remove legacy MainLoop infrastructure (#4343) 1 月之前
local_packages a0979368cb Fixes #4125. Remove legacy MainLoop infrastructure (#4343) 1 月之前
.cursorrules aef88ad4bb Fixes #4332 - Refactor test infrastructure to use modern ApplicationImpl.Coordinator instead of legacy MainLoop (#4335) 1 月之前
.dockerignore 8ab759b30f Fixes #415 v2. Colors: OpenSUSE - The native method "COLOR_PAIRS" does not exist 2 年之前
.editorconfig d3f4c42785 Fixes 4132. .editorconfig has ambiguous configuration with same files (#4133) 6 月之前
.filenesting.json 76d48f1fe8 Add solution default file nesting rules 1 年之前
.gitattributes 98f70b2632 Adds `ViewportSettings.Transparent` (#3886) 9 月之前
.gitignore 5984a3c564 Fixes #3941 - v2win/v2net: UICatalog crash - Fixes warnings (#3946) 9 月之前
.vsconfig 1a68656d66 Add .vsconfig 1 年之前
AGENTS.md aef88ad4bb Fixes #4332 - Refactor test infrastructure to use modern ApplicationImpl.Coordinator instead of legacy MainLoop (#4335) 1 月之前
CODE_OF_CONDUCT.md 6144c9da66 added contribution guidelines, project layout docs, etc... 5 年之前
CONTRIBUTING.md f068709d13 Fixes #4331 - Use Application.Screen and ScreenContents to reduce Driver coupling (#4336) 1 月之前
Directory.Build.props b0f32811eb Fixes #3930 - Splits tests to `Tests/UnitTests`, `Tests/IntegrationTests`, `Tests/StressTests` (#3954) 9 月之前
Directory.Packages.props b83bcc2fdb Fixes #4259. Our wcwidth library is out of date (#4281) 1 月之前
GitVersion.yml f4d4a25704 pre-alpha -> alpha (#4158) 6 月之前
LICENSE 38af4cfcb8 Add 8 年之前
NoSamples.slnf ba4503a2b0 Fixed release builds 4 6 月之前
README.md aef88ad4bb Fixes #4332 - Refactor test infrastructure to use modern ApplicationImpl.Coordinator instead of legacy MainLoop (#4335) 1 月之前
Release.slnf ba4503a2b0 Fixed release builds 4 6 月之前
Terminal.sln aef88ad4bb Fixes #4332 - Refactor test infrastructure to use modern ApplicationImpl.Coordinator instead of legacy MainLoop (#4335) 1 月之前
Terminal.sln.DotSettings b502471ee6 Fixes #4300 - Scrolling intermittently causes All_Scenarios_Quit_And_Init_Shutdown_Properly to fail (#4301) 1 月之前
Terminal.sln.ToDo.DotSettings afa7da3ae5 Fixes #4078 - Implement automatic URL detection with OSC 8 hyperlinks at driver level (#4340) 1 月之前
global.json dcb3b359ad Fixes #2926 - Refactor KeyEvent and KeyEventEventArgs to simplify (#2927) 2 年之前
nuget.config 8fef16d35f Fixes #4116. NativeAot and SelfContained projects aren't working well in release mode (#4117) 6 月之前
pull_request_template.md b84862d0bd Fixes #3172. `Application.ResetState` wasn't resetting all it should (#3173) 1 年之前
testenvironments.json 8ea6b105fc Fixes #2923. Ensures only clear Instances if they really was disposed. (#2924) 2 年之前

README.md

.NET Core Version Code Coverage Downloads License Bugs

Terminal.Gui v2

The premier toolkit for building rich console apps for Windows, the Mac, and Linux/Unix.

logo

  • The current, stable, release of Terminal.Gui v1 is Version.

:warning: Note:
v1 is in maintenance mode and we will only accept PRs for issues impacting existing functionality.

  • The current Alpha release of Terminal.Gui v2 is NuGet Version

:warning: Note:
Developers starting new TUI projects are encouraged to target v2 Alpha. The API is significantly changed, and significantly improved. There will be breaking changes in the API before Beta, but the core API is stable.

Sample app

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

To run the UICatalog demo app that shows all the controls and features of the toolkit, use the following command:

dotnet run --project Examples/UICatalog/UICatalog.csproj

There is also a visual designer (uses Terminal.Gui itself).

Documentation

The full developer documentation for Terminal.Gui is available at gui-cs.github.io/Terminal.Gui.

Getting Started

API Reference

For detailed API documentation, see the API Reference.

Installing

Use NuGet to install the Terminal.Gui NuGet package:

v2 Alpha

(Infrequently updated, but stable enough for production use)

dotnet add package Terminal.Gui --version "2.0.0-alpha.*"

v2 Develop

(Frequently updated, but may have breaking changes)

dotnet add package Terminal.Gui --version "2.0.0-develop.*"

Legacy v1

dotnet add package Terminal.Gui --version "1.*

Or, you can use the Terminal.Gui.Templates.

Contributing

See CONTRIBUTING.md for complete contribution guidelines.

Debates on architecture and design can be found in Issues tagged with design.

History

See gui-cs for how this project came to be.