├── templates └── basic │ ├── Program.cs │ ├── MyGuiCsProject.csproj │ ├── .template.config │ └── template.json │ ├── MyView.cs │ └── MyView.Designer.cs ├── LICENSE ├── .github └── workflows │ └── build.yml ├── Terminal.Gui.templates.csproj ├── README.md └── .gitignore /templates/basic/Program.cs: -------------------------------------------------------------------------------- 1 | using MyGuiCsProject; 2 | using Terminal.Gui; 3 | using Terminal.Gui.App; 4 | using Terminal.Gui.Drawing; 5 | using Terminal.Gui.Input; 6 | using Terminal.Gui.ViewBase; 7 | using Terminal.Gui.Views; 8 | 9 | Application.Init(); 10 | 11 | try 12 | { 13 | Application.Run(new MyView()); 14 | } 15 | finally 16 | { 17 | Application.Shutdown(); 18 | } -------------------------------------------------------------------------------- /templates/basic/MyGuiCsProject.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Exe 5 | net8.0 6 | enable 7 | enable 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /templates/basic/.template.config/template.json: -------------------------------------------------------------------------------- 1 | { 2 | "author": "Thomas Nind", 3 | "classifications": [ "Console", "TUI" ], 4 | "name": "Terminal Gui Basic Template", 5 | "identity": "Terminal.Gui.Templates.Basic", 6 | "groupIdentity":"Terminal.Gui.Templates", 7 | "shortName": "tui", 8 | "tags": { 9 | "language": "C#", 10 | "type":"project" 11 | }, 12 | "sourceName": "MyGuiCsProject", 13 | "preferNameDirectory": true 14 | } -------------------------------------------------------------------------------- /templates/basic/MyView.cs: -------------------------------------------------------------------------------- 1 | 2 | //------------------------------------------------------------------------------ 3 | 4 | // 5 | // This code was generated by: 6 | // TerminalGuiDesigner v2.0.0.0 7 | // You can make changes to this file and they will not be overwritten when saving. 8 | // 9 | // ----------------------------------------------------------------------------- 10 | namespace MyGuiCsProject { 11 | using Terminal.Gui; 12 | 13 | 14 | public partial class MyView { 15 | 16 | public MyView() { 17 | InitializeComponent(); 18 | 19 | button1.Accepting += (s, e) => 20 | { 21 | e.Handled = true; 22 | Terminal.Gui.Views.MessageBox.Query("Hello", "Hello There!", "Ok"); 23 | }; 24 | } 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2022 Thomas Nind 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: Build and package 2 | 3 | on: push 4 | 5 | jobs: 6 | build: 7 | runs-on: ubuntu-latest 8 | 9 | strategy: 10 | matrix: 11 | job: [package-template, test-template] 12 | 13 | steps: 14 | - uses: actions/checkout@v3 15 | 16 | - name: Set up .NET 17 | uses: actions/setup-dotnet@v3 18 | with: 19 | dotnet-version: '8.x' 20 | 21 | - name: Build and Package Template 22 | if: matrix.job == 'package-template' 23 | run: | 24 | dotnet pack 25 | 26 | - name: Publish to NuGet 27 | if: matrix.job == 'package-template' && contains(github.ref, 'refs/tags/v') 28 | run: dotnet nuget push ./bin/Release/*.nupkg --api-key ${{ secrets.NUGET_KEY }} --source https://api.nuget.org/v3/index.json 29 | 30 | - name: Test Template Install and Build 31 | if: matrix.job == 'test-template' 32 | run: | 33 | # Install the template locally 34 | dotnet new --install templates/basic 35 | 36 | # Create a new project from the template 37 | mkdir testapp 38 | cd testapp 39 | dotnet new tui -n myproj 40 | cd myproj 41 | 42 | # Build the generated project 43 | dotnet build 44 | -------------------------------------------------------------------------------- /Terminal.Gui.templates.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Template 5 | 2.0.0-v2-develop.4519 6 | Terminal.gui.templates 7 | Terminal.Gui templates 8 | Thomas Nind 9 | Templates to use when creating an application for Terminal.Gui. 10 | dotnet-new;templates;csharp;terminal;c#;gui;template;consol 11 | net8.0 12 | https://github.com/gui-cs/Terminal.Gui.templates 13 | README.md 14 | MIT 15 | true 16 | false 17 | content 18 | 19 | 2.0.0-v2-develop.4519 20 | - Update for version 2 of Terminal.Gui 21 | 2.0.0-v2-develop.2203 22 | - Update for version 2 of Terminal.Gui (latest Terminal Gui Designer compatible edition) 23 | v1.0.3 24 | - Added Title to window showing quit shortcut 25 | v1.0.2 26 | - Renamed package Terminal.Gui.templates 27 | v1.0.1 28 | - Added README.md to package 29 | - Changed Terminal.Gui package dependency to be 1.* instead of explicitly 1.7.2 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | True 38 | \ 39 | 40 | 41 | 42 | 43 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![NuGet Badge](https://buildstats.info/nuget/Terminal.gui.templates)](https://www.nuget.org/packages/Terminal.gui.templates/) 2 | 3 | # Usage 4 | This is a template for creating Terminal.Gui applications using `dotnet new`. 5 | 6 | To add this template to those available in `dotnet new` you will need to install the NuGet package: 7 | 8 | # V1 9 | 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: 10 | 11 | ``` 12 | dotnet new --install Terminal.Gui.templates 13 | ``` 14 | 15 | # V2 16 | 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. 17 | 18 | ``` 19 | dotnet new install Terminal.Gui.Templates::2.0.0-v2-develop.4519 20 | ``` 21 | 22 | ## Creating projects 23 | 24 | After installing you can use the template to create new projects: 25 | 26 | ``` 27 | dotnet new tui -n myproj 28 | cd myproj 29 | dotnet run 30 | ``` 31 | 32 | ## Next Steps 33 | 34 | 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. 35 | 36 | ``` 37 | dotnet tool install --global TerminalGuiDesigner 38 | TerminalGuiDesigner ./MyView.cs 39 | ``` 40 | 41 | If you are targetting v2 you will need to add `--prerelease`. 42 | 43 | ## Development 44 | For development/testing add this template to `dotnet` using: 45 | 46 | ``` 47 | dotnet new --install D:\Repos\Terminal.Gui.templates\templates\basic 48 | ``` 49 | 50 | To use the template run: 51 | 52 | ``` 53 | dotnet new tui -n myproj 54 | cd myproj 55 | dotnet run 56 | ``` 57 | 58 | To remove it run: 59 | 60 | ``` 61 | dotnet new --uninstall D:\Repos\Terminal.Gui.templates\templates\basic 62 | ``` 63 | -------------------------------------------------------------------------------- /templates/basic/MyView.Designer.cs: -------------------------------------------------------------------------------- 1 | 2 | //------------------------------------------------------------------------------ 3 | 4 | // 5 | // This code was generated by: 6 | // TerminalGuiDesigner v2.0.0.0 7 | // Changes to this file may cause incorrect behavior and will be lost if 8 | // the code is regenerated. 9 | // 10 | // ----------------------------------------------------------------------------- 11 | namespace MyGuiCsProject { 12 | using System; 13 | using Terminal.Gui; 14 | using Terminal.Gui.App; 15 | using Terminal.Gui.Drawing; 16 | using Terminal.Gui.Input; 17 | using Terminal.Gui.ViewBase; 18 | using Terminal.Gui.Views; 19 | using System.Collections; 20 | using System.Collections.Generic; 21 | using System.Collections.ObjectModel; 22 | using System.Drawing; 23 | 24 | 25 | public partial class MyView : Terminal.Gui.Views.Window { 26 | 27 | private Terminal.Gui.Views.Label label; 28 | 29 | private Terminal.Gui.Views.Button button1; 30 | 31 | private void InitializeComponent() { 32 | this.button1 = new Terminal.Gui.Views.Button(); 33 | this.label = new Terminal.Gui.Views.Label(); 34 | this.Width = Dim.Fill(0); 35 | this.Height = Dim.Fill(0); 36 | this.X = 0; 37 | this.Y = 0; 38 | this.Visible = true; 39 | this.Arrangement = Terminal.Gui.ViewBase.ViewArrangement.Overlapped; 40 | this.CanFocus = true; 41 | this.ShadowStyle = Terminal.Gui.ViewBase.ShadowStyle.None; 42 | this.Modal = false; 43 | this.TextAlignment = Terminal.Gui.ViewBase.Alignment.Start; 44 | this.Title = "Press Esc to quit"; 45 | this.label.Width = Dim.Auto(); 46 | this.label.Height = Dim.Auto(); 47 | this.label.X = Pos.Center(); 48 | this.label.Y = Pos.Center(); 49 | this.label.Visible = true; 50 | this.label.Arrangement = Terminal.Gui.ViewBase.ViewArrangement.Fixed; 51 | this.label.CanFocus = false; 52 | this.label.ShadowStyle = Terminal.Gui.ViewBase.ShadowStyle.None; 53 | this.label.Data = "label"; 54 | this.label.Text = "Hello World"; 55 | this.label.TextAlignment = Terminal.Gui.ViewBase.Alignment.Start; 56 | this.Add(this.label); 57 | this.button1.Width = Dim.Auto(); 58 | this.button1.Height = Dim.Auto(); 59 | this.button1.X = Pos.Center(); 60 | this.button1.Y = Pos.Center() + 1; 61 | this.button1.Visible = true; 62 | this.button1.Arrangement = Terminal.Gui.ViewBase.ViewArrangement.Fixed; 63 | this.button1.CanFocus = true; 64 | this.button1.ShadowStyle = Terminal.Gui.ViewBase.ShadowStyle.Opaque; 65 | this.button1.Data = "button1"; 66 | this.button1.Text = "Click Me"; 67 | this.button1.TextAlignment = Terminal.Gui.ViewBase.Alignment.Center; 68 | this.button1.IsDefault = false; 69 | this.Add(this.button1); 70 | } 71 | } 72 | } 73 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ## Ignore Visual Studio temporary files, build results, and 2 | ## files generated by popular Visual Studio add-ons. 3 | ## 4 | ## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore 5 | 6 | # User-specific files 7 | *.rsuser 8 | *.suo 9 | *.user 10 | *.userosscache 11 | *.sln.docstates 12 | 13 | # User-specific files (MonoDevelop/Xamarin Studio) 14 | *.userprefs 15 | 16 | # Mono auto generated files 17 | mono_crash.* 18 | 19 | # Build results 20 | [Dd]ebug/ 21 | [Dd]ebugPublic/ 22 | [Rr]elease/ 23 | [Rr]eleases/ 24 | x64/ 25 | x86/ 26 | [Aa][Rr][Mm]/ 27 | [Aa][Rr][Mm]64/ 28 | bld/ 29 | [Bb]in/ 30 | [Oo]bj/ 31 | [Ll]og/ 32 | [Ll]ogs/ 33 | 34 | # Visual Studio 2015/2017 cache/options directory 35 | .vs/ 36 | # Uncomment if you have tasks that create the project's static files in wwwroot 37 | #wwwroot/ 38 | 39 | # Visual Studio 2017 auto generated files 40 | Generated\ Files/ 41 | 42 | # MSTest test Results 43 | [Tt]est[Rr]esult*/ 44 | [Bb]uild[Ll]og.* 45 | 46 | # NUnit 47 | *.VisualState.xml 48 | TestResult.xml 49 | nunit-*.xml 50 | 51 | # Build Results of an ATL Project 52 | [Dd]ebugPS/ 53 | [Rr]eleasePS/ 54 | dlldata.c 55 | 56 | # Benchmark Results 57 | BenchmarkDotNet.Artifacts/ 58 | 59 | # .NET Core 60 | project.lock.json 61 | project.fragment.lock.json 62 | artifacts/ 63 | 64 | # StyleCop 65 | StyleCopReport.xml 66 | 67 | # Files built by Visual Studio 68 | *_i.c 69 | *_p.c 70 | *_h.h 71 | *.ilk 72 | *.meta 73 | *.obj 74 | *.iobj 75 | *.pch 76 | *.pdb 77 | *.ipdb 78 | *.pgc 79 | *.pgd 80 | *.rsp 81 | *.sbr 82 | *.tlb 83 | *.tli 84 | *.tlh 85 | *.tmp 86 | *.tmp_proj 87 | *_wpftmp.csproj 88 | *.log 89 | *.vspscc 90 | *.vssscc 91 | .builds 92 | *.pidb 93 | *.svclog 94 | *.scc 95 | 96 | # Chutzpah Test files 97 | _Chutzpah* 98 | 99 | # Visual C++ cache files 100 | ipch/ 101 | *.aps 102 | *.ncb 103 | *.opendb 104 | *.opensdf 105 | *.sdf 106 | *.cachefile 107 | *.VC.db 108 | *.VC.VC.opendb 109 | 110 | # Visual Studio profiler 111 | *.psess 112 | *.vsp 113 | *.vspx 114 | *.sap 115 | 116 | # Visual Studio Trace Files 117 | *.e2e 118 | 119 | # TFS 2012 Local Workspace 120 | $tf/ 121 | 122 | # Guidance Automation Toolkit 123 | *.gpState 124 | 125 | # ReSharper is a .NET coding add-in 126 | _ReSharper*/ 127 | *.[Rr]e[Ss]harper 128 | *.DotSettings.user 129 | 130 | # TeamCity is a build add-in 131 | _TeamCity* 132 | 133 | # DotCover is a Code Coverage Tool 134 | *.dotCover 135 | 136 | # AxoCover is a Code Coverage Tool 137 | .axoCover/* 138 | !.axoCover/settings.json 139 | 140 | # Visual Studio code coverage results 141 | *.coverage 142 | *.coveragexml 143 | 144 | # NCrunch 145 | _NCrunch_* 146 | .*crunch*.local.xml 147 | nCrunchTemp_* 148 | 149 | # MightyMoose 150 | *.mm.* 151 | AutoTest.Net/ 152 | 153 | # Web workbench (sass) 154 | .sass-cache/ 155 | 156 | # Installshield output folder 157 | [Ee]xpress/ 158 | 159 | # DocProject is a documentation generator add-in 160 | DocProject/buildhelp/ 161 | DocProject/Help/*.HxT 162 | DocProject/Help/*.HxC 163 | DocProject/Help/*.hhc 164 | DocProject/Help/*.hhk 165 | DocProject/Help/*.hhp 166 | DocProject/Help/Html2 167 | DocProject/Help/html 168 | 169 | # Click-Once directory 170 | publish/ 171 | 172 | # Publish Web Output 173 | *.[Pp]ublish.xml 174 | *.azurePubxml 175 | # Note: Comment the next line if you want to checkin your web deploy settings, 176 | # but database connection strings (with potential passwords) will be unencrypted 177 | *.pubxml 178 | *.publishproj 179 | 180 | # Microsoft Azure Web App publish settings. Comment the next line if you want to 181 | # checkin your Azure Web App publish settings, but sensitive information contained 182 | # in these scripts will be unencrypted 183 | PublishScripts/ 184 | 185 | # NuGet Packages 186 | *.nupkg 187 | # NuGet Symbol Packages 188 | *.snupkg 189 | # The packages folder can be ignored because of Package Restore 190 | **/[Pp]ackages/* 191 | # except build/, which is used as an MSBuild target. 192 | !**/[Pp]ackages/build/ 193 | # Uncomment if necessary however generally it will be regenerated when needed 194 | #!**/[Pp]ackages/repositories.config 195 | # NuGet v3's project.json files produces more ignorable files 196 | *.nuget.props 197 | *.nuget.targets 198 | 199 | # Microsoft Azure Build Output 200 | csx/ 201 | *.build.csdef 202 | 203 | # Microsoft Azure Emulator 204 | ecf/ 205 | rcf/ 206 | 207 | # Windows Store app package directories and files 208 | AppPackages/ 209 | BundleArtifacts/ 210 | Package.StoreAssociation.xml 211 | _pkginfo.txt 212 | *.appx 213 | *.appxbundle 214 | *.appxupload 215 | 216 | # Visual Studio cache files 217 | # files ending in .cache can be ignored 218 | *.[Cc]ache 219 | # but keep track of directories ending in .cache 220 | !?*.[Cc]ache/ 221 | 222 | # Others 223 | ClientBin/ 224 | ~$* 225 | *~ 226 | *.dbmdl 227 | *.dbproj.schemaview 228 | *.jfm 229 | *.pfx 230 | *.publishsettings 231 | orleans.codegen.cs 232 | 233 | # Including strong name files can present a security risk 234 | # (https://github.com/github/gitignore/pull/2483#issue-259490424) 235 | #*.snk 236 | 237 | # Since there are multiple workflows, uncomment next line to ignore bower_components 238 | # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) 239 | #bower_components/ 240 | 241 | # RIA/Silverlight projects 242 | Generated_Code/ 243 | 244 | # Backup & report files from converting an old project file 245 | # to a newer Visual Studio version. Backup files are not needed, 246 | # because we have git ;-) 247 | _UpgradeReport_Files/ 248 | Backup*/ 249 | UpgradeLog*.XML 250 | UpgradeLog*.htm 251 | ServiceFabricBackup/ 252 | *.rptproj.bak 253 | 254 | # SQL Server files 255 | *.mdf 256 | *.ldf 257 | *.ndf 258 | 259 | # Business Intelligence projects 260 | *.rdl.data 261 | *.bim.layout 262 | *.bim_*.settings 263 | *.rptproj.rsuser 264 | *- [Bb]ackup.rdl 265 | *- [Bb]ackup ([0-9]).rdl 266 | *- [Bb]ackup ([0-9][0-9]).rdl 267 | 268 | # Microsoft Fakes 269 | FakesAssemblies/ 270 | 271 | # GhostDoc plugin setting file 272 | *.GhostDoc.xml 273 | 274 | # Node.js Tools for Visual Studio 275 | .ntvs_analysis.dat 276 | node_modules/ 277 | 278 | # Visual Studio 6 build log 279 | *.plg 280 | 281 | # Visual Studio 6 workspace options file 282 | *.opt 283 | 284 | # Visual Studio 6 auto-generated workspace file (contains which files were open etc.) 285 | *.vbw 286 | 287 | # Visual Studio LightSwitch build output 288 | **/*.HTMLClient/GeneratedArtifacts 289 | **/*.DesktopClient/GeneratedArtifacts 290 | **/*.DesktopClient/ModelManifest.xml 291 | **/*.Server/GeneratedArtifacts 292 | **/*.Server/ModelManifest.xml 293 | _Pvt_Extensions 294 | 295 | # Paket dependency manager 296 | .paket/paket.exe 297 | paket-files/ 298 | 299 | # FAKE - F# Make 300 | .fake/ 301 | 302 | # CodeRush personal settings 303 | .cr/personal 304 | 305 | # Python Tools for Visual Studio (PTVS) 306 | __pycache__/ 307 | *.pyc 308 | 309 | # Cake - Uncomment if you are using it 310 | # tools/** 311 | # !tools/packages.config 312 | 313 | # Tabs Studio 314 | *.tss 315 | 316 | # Telerik's JustMock configuration file 317 | *.jmconfig 318 | 319 | # BizTalk build output 320 | *.btp.cs 321 | *.btm.cs 322 | *.odx.cs 323 | *.xsd.cs 324 | 325 | # OpenCover UI analysis results 326 | OpenCover/ 327 | 328 | # Azure Stream Analytics local run output 329 | ASALocalRun/ 330 | 331 | # MSBuild Binary and Structured Log 332 | *.binlog 333 | 334 | # NVidia Nsight GPU debugger configuration file 335 | *.nvuser 336 | 337 | # MFractors (Xamarin productivity tool) working folder 338 | .mfractor/ 339 | 340 | # Local History for Visual Studio 341 | .localhistory/ 342 | 343 | # BeatPulse healthcheck temp database 344 | healthchecksdb 345 | 346 | # Backup folder for Package Reference Convert tool in Visual Studio 2017 347 | MigrationBackup/ 348 | 349 | # Ionide (cross platform F# VS Code tools) working folder 350 | .ionide/ 351 | --------------------------------------------------------------------------------