0

0

C#怎么创建命令行工具 System.CommandLine库使用方法

畫卷琴夢

畫卷琴夢

发布时间:2026-01-21 13:29:02

|

199人浏览过

|

来源于php中文网

原创

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

c#怎么创建命令行工具 system.commandline库使用方法

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);

问小白
问小白

免费使用DeepSeek满血版

下载

// 运行:dotnet run -- commit --message "feat: add login"

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

自动帮助与错误提示

无需手写 --help 逻辑,System.CommandLine 默认支持:

  • 运行 dotnet run -- --help → 显示根命令帮助
  • 运行 dotnet run -- commit --help → 显示 commit 子命令帮助
  • 参数缺失、类型错误时自动报错并提示正确用法

还可自定义帮助文本:root.Description = "一个轻量级文件处理器",或为选项加说明:inputOpt.Description = "必填:UTF-8 编码的 .txt 文件"

基本上就这些。不复杂但容易忽略的是 handler 参数顺序和 option 注册顺序必须严格对应——写错会导致运行时报 ArgumentException。其他高级用法(如自定义类型转换、中间件管道、国际化)可按需查官方文档。

相关专题

更多
什么是中间件
什么是中间件

中间件是一种软件组件,充当不兼容组件之间的桥梁,提供额外服务,例如集成异构系统、提供常用服务、提高应用程序性能,以及简化应用程序开发。想了解更多中间件的相关内容,可以阅读本专题下面的文章。

178

2024.05.11

Golang 中间件开发与微服务架构
Golang 中间件开发与微服务架构

本专题系统讲解 Golang 在微服务架构中的中间件开发,包括日志处理、限流与熔断、认证与授权、服务监控、API 网关设计等常见中间件功能的实现。通过实战项目,帮助开发者理解如何使用 Go 编写高效、可扩展的中间件组件,并在微服务环境中进行灵活部署与管理。

213

2025.12.18

string转int
string转int

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

338

2023.08.02

C++类型转换方式
C++类型转换方式

本专题整合了C++类型转换相关内容,想了解更多相关内容,请阅读专题下面的文章。

299

2025.07.15

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

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

412

2023.08.08

console.log是什么
console.log是什么

console.log 是 javascript 函数,用于在浏览器控制台中输出信息,便于调试和故障排除。想了解更多console.log的相关内容,可以阅读本专题下面的文章。

497

2024.05.29

点击input框没有光标怎么办
点击input框没有光标怎么办

点击input框没有光标的解决办法:1、确认输入框焦点;2、清除浏览器缓存;3、更新浏览器;4、使用JavaScript;5、检查硬件设备;6、检查输入框属性;7、调试JavaScript代码;8、检查页面其他元素;9、考虑浏览器兼容性。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

183

2023.11.24

自建git服务器
自建git服务器

git服务器是目前流行的分布式版本控制系统之一,可以让多人协同开发同一个项目。本专题为大家提供自建git服务器相关的各种文章、以及下载和课程。

641

2023.07.05

excel表格操作技巧大全 表格制作excel教程
excel表格操作技巧大全 表格制作excel教程

Excel表格操作的核心技巧在于 熟练使用快捷键、数据处理函数及视图工具,如Ctrl+C/V(复制粘贴)、Alt+=(自动求和)、条件格式、数据验证及数据透视表。掌握这些可大幅提升数据分析与办公效率,实现快速录入、查找、筛选和汇总。

0

2026.01.21

热门下载

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

精品课程

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

共21课时 | 2.8万人学习

Git版本控制工具
Git版本控制工具

共8课时 | 1.5万人学习

Git中文开发手册
Git中文开发手册

共0课时 | 0人学习

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

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