Skip to content

tui-cs/Terminal.Gui.templates

Repository files navigation

NuGet

Terminal.Gui Templates

dotnet new templates for building Terminal.Gui v2 apps — designed so an AI coding agent can scaffold and extend a TUI app correctly. Every generated project ships an AGENTS.md with the canonical v2 patterns (Terminal.Gui v2 is a complete rewrite, so most online/training-data examples are v1 and won't compile).

Install

dotnet new install Terminal.Gui.Templates

This installs the latest templates targeting current stable Terminal.Gui (net10.0).

Create a project

Every template emits an AGENTS.md + CLAUDE.md — open MyApp/AGENTS.md first. It has the canonical minimal app, the v1→v2 corrections table, Pos/Dim layout, common gotchas, and links to Terminal.Gui's CI-validated docs.

tui — a complete starter (recommended)

A real app to extend: a menu bar, a status bar, and interactive content, wired up with the canonical v2 patterns.

dotnet new tui -n MyApp
cd MyApp
dotnet run            # File > Quit (or the status bar) exits

tui-simple — the minimal app

The smallest runnable v2 app: a Window with a label and a quit button, and a fully commented Program.cs.

dotnet new tui-simple -n MyApp
cd MyApp
dotnet run            # Esc or the Quit button exits

Note: the previous tui-designer template is temporarily not shipped while it's regenerated against current Terminal.Gui — see #24.

Links

About

Template for dotnet new that creates a new Terminal.Gui project

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors