C#命令行参数解析库System.CommandLine使用

第C#命令行参数解析库System.CommandLine使用平常在日常的开发过程中，会经常用到命令行工具。如cmd下的各种命令。

以下为sc命令执行后的截图，可以看到，由于没有输入任何附带参数，所以程序并未执行任何操作，只是输出了描述和用法。

系统在创建一个新进程时，会传一个命令行给它，也就是命令行字符串。

程序需要对命令行字符串进行解析，并执行相应操作。

如使用scquery可以查询当前系统的服务：

在C#中的控制台程序中，Main函数中传入的args字符串数组，就是系统传入进程的命令行参数。

在构建具有复杂命令行参数的控制台程序时，手动解析参数就变得非常麻烦。这里推荐一个开源的库，可以更加方便的解析命令行参数。

System.CommandLine介绍

System.CommandLine是一个基于.NetStandard2.0（支持.NetFrameWork+和.NetCore2.0+）的命令行参数解析库，项目地址/dotnet/command-line-api，目前，该项目还是属于beta状态，期待以后的正式版本。

由于不是正式版本，在Nuget中引用时，需要钩上Includeprerelease，才能找到这个包。

System.CommandLine的一些基本概念

Token(标记)

命令行的每个单词都是一个标记，如下面的"sc"、"query"和"eventlog"都是一个Token

Commands(命令)

Commands就是应用程序根据Token执行相应的操作(在System.CommandLine库中，对应Command类)

RootCommand(根命令)

根命令是代表可执行程序本身的Commands，如sc(在System.CommandLine库中，对应RootCommand类)

SubCommands(子命令)

一些命令行程序会有SubCommands，如上面的scquery中的query就是子命令(在System.CommandLine，对应Command类)

Options(可选项)

Options就是传递给Commands的命名参数，如app-myoption123中的-myoption123就是一个Options

Argument(参数)

参数就是传递给选项或命令的值。

说明：

常规的调用如下：

xx.exe[options]argument[command]

Delimiters（分隔符）

分隔符就是把Options的命令和值分开的符号

如下三种写法都是一样的，可以使用空格、=或：符号

app-myoption123

app-myoption=123

app-myoption:123

Aliases(别名)

可以为命令或选项设置较短的别名，如

-v,--verbose

--o,--option

System.CommandLine使用

在下面的示例中，我们会构建一个简单的控制台爬虫工具。

1、使用VisualStudio2025创建一个.NetCore控制台程序crawler-line

2、导入System.CommandLine包

3、创建一个RootCommand

varrootCommand=newRootCommand

newArgumentstring(

"url","websiteurl"),

newOptionbool(newstring[]{"--gethtml","-html"},"Gethtmlsource"),

newOptionbool(newstring[]{"--getimage","-image"},"Getimages"),

newOptionbool(newstring[]{"--regex-option","-regex"},"Useregex"),

newOptionbool(newstring[]{"--htmlagilitypack-option","-agpack"},"UseHtmlAgilityPack"),

newOptionbool(newstring[]{"--anglesharp-option","-agsharp"},"UseAngleSharp"),

newOptionstring(newstring[]{"--download-path","-path"},"Designatedownloadpath"),13};

说明：

可通过Option类的构造函数重载，为Option指定默认值。

publicOption(stringalias,FuncTgetDefaultValue,stringdescription=null);

如上面的-pathOption，指定默认值为D:\download，如下：

newOptionstring(newstring[]{"--download-path","-path"},getDefaultValue:()="D:\\download","Designatedownloadpath"),

也可以先实例化RootCommand对象，再通过Add的方式添加Argument和Option，如下：

varrootCommand=newRootCommand();

//添加Argument

rootCommand.AddArgument(newArgumentstring("url","websiteurl"));

//添加Option

rootCommand.AddOption(newOptionstring(newstring[]{"--download-path","-path"},"downloadpath"));

4、添加当前命令行程序的描述信息

rootCommand.Description=".NetCorecommand-linecrawler.";

5、解析Argument和Option

rootCommand.Handler=CommandHandler.Createstring,bool,bool,bool,bool,bool,string((stringurl,boolhtml,boolimage,boolregex,boolagpack,boolagsharp,stringpath)={

});

如果觉得参数太长，可以封装成类，再进行调用，如下：

publicclassCrawlerOption

publicstringUrl{get;set;}

publicboolGetHtml{get;set;}

publicboolGetImage{get;set;}

publicboolRe