使用 CliWrap 让C#中的命令行交互举重若轻
在代码中进行命令行交互是一个很常见的场景, 特别是在一些CI CD 自动化流程中, 在这之前我们会使用 System.Diagnostics.Process
API, 现在有一个更灵活的工具 CliWarp, 这是一个在 .NET 平台使用的命令行交互工具库, 通过在C# 中使用 Fluent 的API, 让命令行交互举重若轻。
https://github.com/Tyrrrz/CliWrap
主要特性如下:
•基于 System.Diagnostics.Process
•简单, 流畅的 API 设计
•灵活的支持管道模式
•安全异步并且支持 cancellation API
•跨平台, 可在 Windows、Linux 和 macOS 使用
•支持 .NET Standard 2.0+、.NET Core 3.0+、.NET Framework 4.6.1+
和 shell 是类似的,CliWrap 的基本工作单元是一个 command
, 首先会执行 Cli.Wrap(...) 创建 command, 参数是可执行文件的路径, 然后通过 fluent api 配置, 最后调用 ExecuteAsync
运行命令,如下:
using CliWrap;using CliWrap.Buffered;var result = await Cli.Wrap("path/to/exe") //.... .ExecuteBufferedAsync();
配置参数
var cmd = Cli.Wrap("git") .WithArguments("commit -m \"my commit\"");
var cmd = Cli.Wrap("git") .WithArguments(new[] {"commit", "-m", "my commit"});
var cmd = Cli.Wrap("git") .WithArguments(args => args .Add("clone") .Add("https://github.com/Tyrrrz/CliWrap") .Add("--depth") .Add(20));
配置工作目录
默认是当前目录, 你也可以指定文件夹的相对路径和绝对路径
var cmd = Cli.Wrap("git") .WithWorkingDirectory("c:/projects/my project/");
配置环境变量
var cmd = Cli.Wrap("git") .WithEnvironmentVariables(env => env .Set("GIT_AUTHOR_NAME", "John") .Set("GIT_AUTHOR_EMAIL", "john@email.com"));
超时和取消
using var cts = new CancellationTokenSource(); cts.CancelAfter(TimeSpan.FromSeconds(10));var result = await Cli.Wrap("path/to/exe").ExecuteAsync(cts.Token);
基于拉取的事件流
除了执行命令之外,CliWrap 还支持事件流模型, 可以订阅相关的事件回调。
•StartedCommandEvent -- 仅接收一次,当命令开始执行时(包含 process ID)•StandardOutputCommandEvent -- 每次底层进程向输出流写入新行时收到(包含文本作为字符串)•StandardErrorCommandEvent -- 每次底层进程向错误流写入新行时收到(包含文本作为字符串)•ExitedCommandEvent -- 仅接收一次,当命令完成执行时(包含 exit code)
using CliWrap;using CliWrap.EventStream;var cmd = Cli.Wrap("foo").WithArguments("bar");await foreach (var cmdEvent in cmd.ListenAsync()){ switch (cmdEvent) { case StartedCommandEvent started: _output.WriteLine($"Process started; ID: {started.ProcessId}"); break; case StandardOutputCommandEvent stdOut: _output.WriteLine($"Out> {stdOut.Text}"); break; case StandardErrorCommandEvent stdErr: _output.WriteLine($"Err> {stdErr.Text}"); break; case ExitedCommandEvent exited: _output.WriteLine($"Process exited; Code: {exited.ExitCode}"); break; }}
输出结果如下:
希望对您有用!
https://github.com/Tyrrrz/CliWrap
使用 CliWrap 让C#中的命令行交互举重若轻相关推荐
- C#中实现命令行交互输入输出
场景 C#中实现人与cmd输入输出交互. 效果 实现 using System; using System.Collections.Generic; using System.Text;namespa ...
- mysql隐藏密码_MySQL在Linux系统中隐藏命令行中的密码的方法
在命令行中输入命令并不是一个好主意,会造成安全问题.但是如果你决定去写一个应用,而这个应用需要在命令行中使用密码或者其他敏感信息.那么,你能通过以下方法禁止系统的其他用户轻易的看到这些敏感数据 呢?, ...
- 如何在Java中解析命令行参数?
在Java中解析命令行参数的好方法是什么? #1楼 我不建议使用Apache Common CLI库,因为它是非线程安全的. 它使用带有静态变量和方法的有状态类来进行内部工作(例如OptionBuil ...
- linux安装virtualbox命令,在Linux中从命令行查找Virtualbox Version的方法
在我的Ubuntu无头服务器上使用Virtualbox时,我需要找到Virtualbox的版本,如果是GUI,我可以通过导航到Virtualbox->About->Help轻松找到它,但我 ...
- Windows中的命令行提示符里的Start命令执行路径包含空格时的问题
转自:http://www.x2009.net/articles/windows-command-line-prompt-start-path-space.html 当使用Windows 中的命令行提 ...
- VS中添加命令行参数的方法
在VS中向命令行添加参数,即向main()函数传递参数的方法: 右键单击:添加参数的工程-->属性-->配置属性-->调试,在右侧"命令参数"栏输入要添加的参数, ...
- JavaJDK中的命令行工具
JavaJDK中的命令行工具 本文内容主要学习自<深入理解Java虚拟机>,超赞的一本书强烈推荐! 一,常用JDK监控和故障处理工具 命令名称 全称 用途 jstat JVM Statis ...
- php 开启命令模式,如何启用PhpStorm中的命令行工具
本篇文章主要给大家介绍如何使用phpstorm中的命令行工具. PhpStorm下载地址: PhpStorm使用命令行工具,我们可以直接从IDE调用命令!在我们使用任何命令行工具之前,我们必须在设置中 ...
- nodejs命令行执行程序_在NodeJS中编写命令行应用程序
nodejs命令行执行程序 by Peter Benjamin 彼得·本杰明(Peter Benjamin) 在NodeJS中编写命令行应用程序 (Writing Command-Line Appli ...
最新文章
- 项目实践中的一些性能优化指南
- (chap4 Http状态码) 3XX重定向
- 数据库mysql中delimiter的作用和用法
- 【模板】 全排列 有重复元素的全排列
- (86)FPGA读文件激励(readmemh)
- ES deeping pageing
- 外行人都能看得懂的机器学习,错过了血亏!
- Libata错误信息解析
- uniapp+canvas实现app在线电子签名
- java.lang.IllegalArgumentException: Malformed \uxxxx encoding
- 各公司 Java 面试题目整理(基础+高级+算法+数据库)
- 蓝牙BQB认证的过程与方式(SIG)
- python用循环打出阶梯图形_Python制图你真的会吗?一文学会如何绘制漂亮的阶梯图...
- php输出setcookie,PHP函数:setcookie()
- 常用激活函数(Sigmiod、Tanh、Softmax、ReLU、elu、LReLU、Softplus)函数表达式、特点、图像绘制(代码)---已解决
- nginx配置之判断请求来源
- 在手机端浏览pdf文件,遇到的问题整理
- 固态硬盘与普通硬盘区别
- Golang Protocol Buffers数据格式教程
- open BMC开发(三) IPMI功能配置添加