C#怎么创建命令行工具 System.CommandLine库使用方法_技术教程

System.CommandLine 创建 C# 命令行工具需定义命令、选项、参数并绑定处理逻辑；安装 v2.0.0-beta4 或更高版；用 RootCommand 和 Option/Argument 构建结构；SetHandler 参数顺序须与注册顺序一致；支持子命令、自动帮助及错误提示。

用 System.CommandLine 创建 C# 命令行工具，核心是定义命令、选项、参数，再绑定处理逻辑——它比手动解析 args 更清晰，也比传统 Console.ReadLine() 交互更专业。

安装 System.CommandLine

在项目中通过 NuGet 安装最新稳定版（推荐 v2.0.0-beta4 或更高）：

CLI 方式：dotnet add package System.CommandLine --version 2.0.0-beta4
或在 .csproj 中添加：

注意：v2 是当前主推版本，API 更统一，文档和示例也以 v2 为主；避免混用 v1（已归档）。

定义基础命令和选项

从 RootCommand 开始，用 Option 添加开关，用 Argument 接收位置参数：

var root = new RootCommand("我的工具：处理文本文件");
var inputOpt = new Option("--input", "输入文件路径") { IsRequired = true };
var verboseOpt = new Option("--verbose", "显示详细日志");
root.AddOption(inputOpt);
root.AddOption(verboseOpt);
root.SetHandler((input, verbose) =>
{
Console.WriteLine($"处理文件：{input}");
if (verbose) Console.WriteLine("详细模式已启用");
}, inputOpt, verboseOpt);

关键点：
- SetHandler 绑定执行逻辑，参数顺序必须与 AddOption / AddArgument 传入顺序一致
- 选项名支持短格式（如 -i）和长格式（--input），可同时注册：new Option("-i", "--input", ...)

支持子命令（如 git commit / push）

用 Command 创建子命令，再挂到根命令下：

var commitCmd = new Command("commit", "提交更改");
var messageOpt = new Option("--message", "提交信息");
commitCmd.AddOption(messageOpt);
commitCmd.SetHandler(msg => Console.WriteLine($"提交：{msg}"), messageOpt);
root.AddCommand(commitCmd);
// 运行：dotnet run -- commit --message "feat: add login"

子命令可嵌套多层，适合功能复杂的 CLI 工具（比如 dotnet tool restore 中的 tool 是命令，restore 是其子命令）。