├── .gitignore ├── CommandLineApp.sln ├── CommandLineApp ├── CommandLineApp.csproj └── Program.cs ├── LICENSE └── README.md /.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 | -------------------------------------------------------------------------------- /CommandLineApp.sln: -------------------------------------------------------------------------------- 1 |  2 | Microsoft Visual Studio Solution File, Format Version 12.00 3 | # Visual Studio Version 16 4 | VisualStudioVersion = 16.0.30503.244 5 | MinimumVisualStudioVersion = 10.0.40219.1 6 | Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CommandLineApp", "CommandLineApp\CommandLineApp.csproj", "{277F9A98-D6FF-4D80-82B6-0C036AF65096}" 7 | EndProject 8 | Global 9 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 10 | Debug|Any CPU = Debug|Any CPU 11 | Release|Any CPU = Release|Any CPU 12 | EndGlobalSection 13 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 14 | {277F9A98-D6FF-4D80-82B6-0C036AF65096}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 15 | {277F9A98-D6FF-4D80-82B6-0C036AF65096}.Debug|Any CPU.Build.0 = Debug|Any CPU 16 | {277F9A98-D6FF-4D80-82B6-0C036AF65096}.Release|Any CPU.ActiveCfg = Release|Any CPU 17 | {277F9A98-D6FF-4D80-82B6-0C036AF65096}.Release|Any CPU.Build.0 = Release|Any CPU 18 | EndGlobalSection 19 | GlobalSection(SolutionProperties) = preSolution 20 | HideSolutionNode = FALSE 21 | EndGlobalSection 22 | GlobalSection(ExtensibilityGlobals) = postSolution 23 | SolutionGuid = {06FB0A74-5B0C-4F91-8C53-A3E70226062C} 24 | EndGlobalSection 25 | EndGlobal 26 | -------------------------------------------------------------------------------- /CommandLineApp/CommandLineApp.csproj: -------------------------------------------------------------------------------- 1 |  2 | 3 | 4 | Exe 5 | netcoreapp3.1 6 | enable 7 | true 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /CommandLineApp/Program.cs: -------------------------------------------------------------------------------- 1 | using System.CommandLine; 2 | using System.CommandLine.Invocation; 3 | using System.CommandLine.IO; 4 | using System.Reflection; 5 | using System.Threading; 6 | using System.Threading.Tasks; 7 | 8 | namespace CommandLineApp 9 | { 10 | public static class Program 11 | { 12 | public static async Task Main(string[] args) 13 | { 14 | var cmd = new RootCommand 15 | { 16 | new Command("greeting", "Say hi.") 17 | { 18 | new Argument("name", "Your name."), 19 | new Option(new[] { "--greeting", "-g" }, "The greeting to use."), 20 | new Option(new[] { "--verbose", "-v" }, "Show the deets."), 21 | }.WithHandler(nameof(HandleGreeting)), 22 | new Command("echo", "Stop copying me!") 23 | { 24 | new Command("times", "Repeat a number of times.") 25 | { 26 | new Argument("words", "The thing you are saying."), 27 | new Option(new[] { "--count", "-c" }, description: "The number of times to copy you.", 28 | getDefaultValue: () => 1), 29 | new Option(new[] { "--delay", "-d" }, description: "The delay between each echo.", 30 | getDefaultValue: () => 100), 31 | new Option(new[] { "--verbose", "-v" }, "Show the deets."), 32 | }.WithHandler(nameof(HandleEchoTimesAsync)), 33 | new Command("forever", "Just keep repeating.") 34 | { 35 | new Argument("words", "The thing you are saying."), 36 | new Option(new[] { "--delay", "-d" }, description: "The delay between each echo.", 37 | getDefaultValue: () => 100), 38 | new Option(new[] { "--verbose", "-v" }, "Show the deets."), 39 | }.WithHandler(nameof(HandleEchoForeverAsync)), 40 | }, 41 | }; 42 | 43 | return await cmd.InvokeAsync(args); 44 | } 45 | 46 | // The sub-command 47 | //public static int Main(string[] args) 48 | //{ 49 | // var greeting = new Command("greeting", "Say hi.") 50 | // { 51 | // new Argument("name", "Your name."), 52 | // new Option(new[] { "--greeting", "-g" }, "The greeting to use."), 53 | // new Option(new[] { "--verbose", "-v" }, "Show the deets."), 54 | // }; 55 | // greeting.Handler = CommandHandler.Create(HandleGreeting); 56 | // var cmd = new RootCommand 57 | // { 58 | // greeting 59 | // }; 60 | // return cmd.Invoke(args); 61 | //} 62 | 63 | // The basic command 64 | //public static int Main(string[] args) 65 | //{ 66 | // var cmd = new RootCommand 67 | // { 68 | // new Argument("name", "Your name."), 69 | // new Option(new[] { "--greeting", "-g" }, "The greeting to use."), 70 | // new Option(new[] { "--verbose", "-v" }, "Show the deets."), 71 | // }; 72 | // cmd.Handler = CommandHandler.Create(HandleGreeting); 73 | // return cmd.Invoke(args); 74 | //} 75 | 76 | private static async Task HandleEchoTimesAsync(string words, int count, int delay, bool verbose, IConsole console, CancellationToken cancellationToken) 77 | { 78 | if (count <= 0) 79 | { 80 | console.Error.WriteLine($"The count needs to be at least 1."); 81 | return 1; 82 | } 83 | 84 | if (delay < 0) 85 | { 86 | console.Error.WriteLine($"The delay needs to be 0 or a positive number."); 87 | return 1; 88 | } 89 | 90 | if (verbose) 91 | console.Out.WriteLine($"About to repeat '{words}' {count} time[s]..."); 92 | 93 | for (var i = 0; i < count; i++) 94 | { 95 | console.Out.WriteLine(words); 96 | 97 | if (verbose) 98 | console.Out.WriteLine($"Sleeping for {delay}ms..."); 99 | 100 | await Task.Delay(delay, cancellationToken); 101 | } 102 | 103 | if (verbose) 104 | console.Out.WriteLine($"All done!"); 105 | 106 | return 0; 107 | } 108 | 109 | private static async Task HandleEchoForeverAsync(string words, int delay, bool verbose, IConsole console, CancellationToken cancellationToken) 110 | { 111 | if (delay < 0) 112 | { 113 | console.Error.WriteLine($"The delay needs to be 0 or a positive number."); 114 | return 1; 115 | } 116 | 117 | if (verbose) 118 | console.Out.WriteLine($"About to repeat '{words}' forever..."); 119 | 120 | while (!cancellationToken.IsCancellationRequested) 121 | { 122 | console.Out.WriteLine(words); 123 | 124 | if (verbose) 125 | console.Out.WriteLine($"Sleeping for {delay}ms..."); 126 | 127 | await Task.Delay(delay, cancellationToken); 128 | } 129 | 130 | if (verbose) 131 | console.Out.WriteLine($"All done! Weird that it got here at all..."); 132 | 133 | return 0; 134 | } 135 | 136 | private static void HandleGreeting(string name, string? greeting, bool verbose, IConsole console) 137 | { 138 | if (verbose) 139 | console.Out.WriteLine($"About to say hi to '{name}'..."); 140 | 141 | greeting ??= "Hi"; 142 | console.Out.WriteLine($"{greeting} {name}!"); 143 | 144 | if (verbose) 145 | console.Out.WriteLine($"All done!"); 146 | } 147 | 148 | // helpers 149 | 150 | private static Command WithHandler(this Command command, string methodName) 151 | { 152 | var method = typeof(Program).GetMethod(methodName, BindingFlags.NonPublic | BindingFlags.Static); 153 | var handler = CommandHandler.Create(method!); 154 | command.Handler = handler; 155 | return command; 156 | } 157 | } 158 | } 159 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2020 Matthew Leibowitz 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 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # CommandLineApp 2 | 3 | Your first app made with System.CommandLine. 4 | 5 | The code for the blog post: https://dotnetdevaddict.co.za/2020/09/25/getting-started-with-system-commandline/ 6 | --------------------------------------------------------------------------------