https://github.com/gui-cs/terminal.gui.templates
Template for dotnet new that creates a new Terminal.Gui project
https://github.com/gui-cs/terminal.gui.templates
Last synced: 2 months ago
JSON representation
Template for dotnet new that creates a new Terminal.Gui project
- Host: GitHub
- URL: https://github.com/gui-cs/terminal.gui.templates
- Owner: gui-cs
- License: mit
- Created: 2022-08-31T10:50:54.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-19T18:07:44.000Z (9 months ago)
- Last Synced: 2025-04-02T08:32:16.533Z (3 months ago)
- Language: C#
- Size: 22.5 KB
- Stars: 34
- Watchers: 4
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.nuget.org/packages/Terminal.gui.templates/)
# Usage
This is a template for creating Terminal.Gui applications using `dotnet new`.
To add this template to those available in `dotnet new` you will need to install the NuGet package:
# V1
Version 1 of [Terminal.Gui](https://github.com/gui-cs/Terminal.Gui) is stable and actively maintained but does not receive new features. To create projects using the V1 template install the latest version of the template:
```
dotnet new --install Terminal.Gui.templates
```
# V2
Version 2 of [Terminal.Gui](https://github.com/gui-cs/Terminal.Gui) is in alpha. To create projects using the v2 template you install the [latest version from nuget.org](https://www.nuget.org/packages/Terminal.gui.templates) e.g.
```
dotnet new install Terminal.Gui.Templates::2.0.0-v2-develop.2203
```
## Creating projects
After installing you can use the template to create new projects:
```
dotnet new tui -n myproj
cd myproj
dotnet run
```
## Next Steps
The basic template includes `MyView.cs` which was created by [TerminalGuiDesigner](https://github.com/gui-cs/TerminalGuiDesigner). You can delete edit this file with the visual designer using the code below or delete it and create your own `Window`/`TopLevel` class manually.
```
dotnet tool install --global TerminalGuiDesigner
TerminalGuiDesigner ./MyView.cs
```
If you are targetting v2 you will need to add `--prerelease`.
## Development
For development/testing add this template to `dotnet` using:
```
dotnet new --install D:\Repos\Terminal.Gui.templates\templates\basic
```
To use the template run:
```
dotnet new tui -n myproj
cd myproj
dotnet run
```
To remove it run:
```
dotnet new --uninstall D:\Repos\Terminal.Gui.templates\templates\basic
```