0

0

C# System.CommandLine使用方法 C#如何构建功能强大的命令行工具

星降

星降

发布时间:2026-03-05 10:19:03

|

411人浏览过

|

来源于php中文网

原创

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

c# system.commandline使用方法 c#如何构建功能强大的命令行工具

System.CommandLine 是什么,值不值得用 它不是 .NET 内置的旧式 args 解析器,也不是第三方 CLI 库(比如 McMaster.Extensions.CommandLineUtils),而是微软官方维护、专为现代 .NET CLI 场景设计的库。它支持子命令、强类型绑定、自动帮助生成、参数验证、颜色输出和 Tab 补全(需配合 shell 配置)。如果你要写一个需要长期维护、有多个子命令、要发布到 nuget 或 dotnet tool 的工具System.CommandLine 是目前最稳妥的选择。

从零开始添加命令和选项(.NET 6+ 推荐方式) 核心是定义 RootCommand,再往里加 OptionCommand。不要直接操作 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 = trueOption 更符合 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 解析。常见坑点:
  • DateTimeTimeSpan 等类型默认解析依赖 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脚本编写基础 中文WORD版
Shell脚本编写基础 中文WORD版

Shell本身是一个用C语言编写的程序,它是用户使用Linux的桥梁。Shell既是一种命令语言,又是一种程序设计语言。作为命令语言,它交互式地解释和执行用户输入的命令;作为程序设计语言,它定义了各种变量和参数,并提供了许多在高级语言中才具有的控制结构,包括循环和分支。它虽然不是Linux系统核心的一部分,但它调用了系统核心的大部分功能来执行程序、建立文件并以并行的方式协调各个程序的运行。因此,对于用户来说,shell是最重要的实用程序,深入了解和熟练掌握shell的特性极其使用方法,是用好Linux系统

下载

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

930

2023.08.02

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

252

2023.09.22

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

1008

2024.03.01

堆和栈的区别
堆和栈的区别

堆和栈的区别:1、内存分配方式不同;2、大小不同;3、数据访问方式不同;4、数据的生命周期。本专题为大家提供堆和栈的区别的相关的文章、下载、课程内容,供大家免费下载体验。

434

2023.07.18

堆和栈区别
堆和栈区别

堆(Heap)和栈(Stack)是计算机中两种常见的内存分配机制。它们在内存管理的方式、分配方式以及使用场景上有很大的区别。本文将详细介绍堆和栈的特点、区别以及各自的使用场景。php中文网给大家带来了相关的教程以及文章欢迎大家前来学习阅读。

600

2023.08.10

堆和栈的区别
堆和栈的区别

堆和栈的区别:1、内存分配方式不同;2、大小不同;3、数据访问方式不同;4、数据的生命周期。本专题为大家提供堆和栈的区别的相关的文章、下载、课程内容,供大家免费下载体验。

434

2023.07.18

堆和栈区别
堆和栈区别

堆(Heap)和栈(Stack)是计算机中两种常见的内存分配机制。它们在内存管理的方式、分配方式以及使用场景上有很大的区别。本文将详细介绍堆和栈的特点、区别以及各自的使用场景。php中文网给大家带来了相关的教程以及文章欢迎大家前来学习阅读。

600

2023.08.10

console接口是干嘛的
console接口是干嘛的

console接口是一种用于在计算机命令行或浏览器开发工具中输出信息的工具,提供了一种简单的方式来记录和查看应用程序的输出结果和调试信息。本专题为大家提供console接口相关的各种文章、以及下载和课程。

419

2023.08.08

Rust内存安全机制与所有权模型深度实践
Rust内存安全机制与所有权模型深度实践

本专题围绕 Rust 语言核心特性展开,深入讲解所有权机制、借用规则、生命周期管理以及智能指针等关键概念。通过系统级开发案例,分析内存安全保障原理与零成本抽象优势,并结合并发场景讲解 Send 与 Sync 特性实现机制。帮助开发者真正理解 Rust 的设计哲学,掌握在高性能与安全性并重场景中的工程实践能力。

2

2026.03.05

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
React 教程
React 教程

共58课时 | 5.7万人学习

Pandas 教程
Pandas 教程

共15课时 | 1.1万人学习

ASP 教程
ASP 教程

共34课时 | 5.6万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号