system.commandline 是微软官方维护的现代 .net cli 库,支持子命令、强类型绑定、自动帮助、验证及 tab 补全;推荐用于需长期维护、多子命令、发布为 dotnet tool 的场景。

System.CommandLine 是什么,值不值得用
它不是 .NET 内置的旧式 args 解析器,也不是第三方 CLI 库(比如 McMaster.Extensions.CommandLineUtils),而是微软官方维护、专为现代 .NET CLI 场景设计的库。它支持子命令、强类型绑定、自动帮助生成、参数验证、颜色输出和 Tab 补全(需配合 shell 配置)。如果你要写一个需要长期维护、有多个子命令、要发布到 nuget 或 dotnet tool 的工具,System.CommandLine 是目前最稳妥的选择。
从零开始添加命令和选项(.NET 6+ 推荐方式)
核心是定义 RootCommand,再往里加 Option 和 Command。不要直接操作 args 数组,也不要用反射绑定——它靠的是显式声明 + 委托执行。
- 使用
dotnet add package System.CommandLine 添加引用(注意版本:推荐 2.0.0-beta4.22272.1 或更高,避免 2.0.0-beta1~beta3 中已知的 ParseResult.GetValueForOption 空引用问题)
- 在
Main 中构建命令树,而不是传入委托后立刻执行:延迟解析才能支持 --help、错误提示等内置逻辑
- 选项名统一用双横线(
--input),短名用单横线(-i),二者可共存但必须显式调用 AddAlias
- 必填参数建议用
Argument<string></string> 并设 Arity = ArgumentArity.ExactlyOne,比依赖 IsRequired = true 的 Option 更符合 CLI 直觉
var root = new RootCommand("MyTool: process files");
var inputOpt = new Option<string>("--input", "Input file path");
inputOpt.AddAlias("-i");
root.AddOption(inputOpt);
<p>root.SetHandler((input) =>
{
Console.WriteLine($"Processing {input}");
}, inputOpt);</p><p>return await root.InvokeAsync(args);
处理子命令(如 git commit / git push 风格)
子命令不是“嵌套函数”,而是独立的 Command 实例,挂载到父级下。每个子命令可拥有自己的选项、参数和处理器,互不影响。
- 子命令名区分大小写,且不能与父命令已有选项重名(否则
ParseResult 会静默失败)
- 多级子命令(如
mytool db migrate up)需逐层 AddCommand,不能跳级
- 不要给子命令设置
IsRequired = true——子命令本身是可选动作,没指定时应默认触发根命令逻辑或报错
- 如果想让某个子命令成为默认行为(用户不输子命令时也执行它),需在
root.SetHandler 之外手动检查 ParseResult.CommandResult.Command 是否为根命令
绑定复杂参数和自定义验证System.CommandLine 支持泛型 Option<t></t>,但 T 必须能被 ConvertFromString 或你注册的 Converter 解析。常见坑点:
-
DateTime、TimeSpan 等类型默认解析依赖 CultureInfo.CurrentCulture,跨区域运行可能失败;建议用 Option<string></string> + 手动 DateTimeOffset.TryParseExact
- 枚举类型需注册转换器:
option.AddValidator(result => Enum.TryParse(result.Tokens.First().Value, out MyEnum _))
- 文件路径类参数,别只靠
Exists 检查——--input /dev/null 在 Linux 下存在但不可读,应在 SetHandler 中做实际 IO 校验
- 错误提示不能只抛异常:用
result.ErrorMessage = "xxx" + return 1,否则帮助文本不会显示,用户只看到未处理异常堆栈
RootCommand,再往里加 Option 和 Command。不要直接操作 args 数组,也不要用反射绑定——它靠的是显式声明 + 委托执行。
- 使用
dotnet add package System.CommandLine添加引用(注意版本:推荐 2.0.0-beta4.22272.1 或更高,避免 2.0.0-beta1~beta3 中已知的ParseResult.GetValueForOption空引用问题) - 在
Main中构建命令树,而不是传入委托后立刻执行:延迟解析才能支持--help、错误提示等内置逻辑 - 选项名统一用双横线(
--input),短名用单横线(-i),二者可共存但必须显式调用AddAlias - 必填参数建议用
Argument<string></string>并设Arity = ArgumentArity.ExactlyOne,比依赖IsRequired = true的Option更符合 CLI 直觉
var root = new RootCommand("MyTool: process files");
var inputOpt = new Option<string>("--input", "Input file path");
inputOpt.AddAlias("-i");
root.AddOption(inputOpt);
<p>root.SetHandler((input) =>
{
Console.WriteLine($"Processing {input}");
}, inputOpt);</p><p>return await root.InvokeAsync(args);
处理子命令(如 git commit / git push 风格)
子命令不是“嵌套函数”,而是独立的 Command 实例,挂载到父级下。每个子命令可拥有自己的选项、参数和处理器,互不影响。
- 子命令名区分大小写,且不能与父命令已有选项重名(否则
ParseResult 会静默失败)
- 多级子命令(如
mytool db migrate up)需逐层 AddCommand,不能跳级
- 不要给子命令设置
IsRequired = true——子命令本身是可选动作,没指定时应默认触发根命令逻辑或报错
- 如果想让某个子命令成为默认行为(用户不输子命令时也执行它),需在
root.SetHandler 之外手动检查 ParseResult.CommandResult.Command 是否为根命令
绑定复杂参数和自定义验证System.CommandLine 支持泛型 Option<t></t>,但 T 必须能被 ConvertFromString 或你注册的 Converter 解析。常见坑点:
-
DateTime、TimeSpan 等类型默认解析依赖 CultureInfo.CurrentCulture,跨区域运行可能失败;建议用 Option<string></string> + 手动 DateTimeOffset.TryParseExact
- 枚举类型需注册转换器:
option.AddValidator(result => Enum.TryParse(result.Tokens.First().Value, out MyEnum _))
- 文件路径类参数,别只靠
Exists 检查——--input /dev/null 在 Linux 下存在但不可读,应在 SetHandler 中做实际 IO 校验
- 错误提示不能只抛异常:用
result.ErrorMessage = "xxx" + return 1,否则帮助文本不会显示,用户只看到未处理异常堆栈
ParseResult 会静默失败)mytool db migrate up)需逐层 AddCommand,不能跳级IsRequired = true——子命令本身是可选动作,没指定时应默认触发根命令逻辑或报错root.SetHandler 之外手动检查 ParseResult.CommandResult.Command 是否为根命令System.CommandLine 支持泛型 Option<t></t>,但 T 必须能被 ConvertFromString 或你注册的 Converter 解析。常见坑点:
-
DateTime、TimeSpan等类型默认解析依赖CultureInfo.CurrentCulture,跨区域运行可能失败;建议用Option<string></string>+ 手动DateTimeOffset.TryParseExact - 枚举类型需注册转换器:
option.AddValidator(result => Enum.TryParse(result.Tokens.First().Value, out MyEnum _)) - 文件路径类参数,别只靠
Exists检查——--input /dev/null在 Linux 下存在但不可读,应在SetHandler中做实际 IO 校验 - 错误提示不能只抛异常:用
result.ErrorMessage = "xxx"+return 1,否则帮助文本不会显示,用户只看到未处理异常堆栈
多层级命令、类型安全绑定、错误提示粒度,这些能力都得靠显式配置撑起来。没人替你猜意图,但换来的是稳定性和可测试性——ParseResult 可以直接单元测试,不用启动进程或 mock Console。
Shell本身是一个用C语言编写的程序,它是用户使用Linux的桥梁。Shell既是一种命令语言,又是一种程序设计语言。作为命令语言,它交互式地解释和执行用户输入的命令;作为程序设计语言,它定义了各种变量和参数,并提供了许多在高级语言中才具有的控制结构,包括循环和分支。它虽然不是Linux系统核心的一部分,但它调用了系统核心的大部分功能来执行程序、建立文件并以并行的方式协调各个程序的运行。因此,对于用户来说,shell是最重要的实用程序,深入了解和熟练掌握shell的特性极其使用方法,是用好Linux系统







