C#中使用CliWrap让命令行交互举重若轻

更新时间：2021年12月31日 10:13:20 作者：SpringLeee

这篇文章介绍了C#中使用CliWrap让命令行交互举重若轻，文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下

在代码中进行命令行交互是一个很常见的场景, 特别是在一些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

到此这篇关于C#中使用CliWrap让命令行交互举重若轻的文章就介绍到这了。希望对大家的学习有所帮助，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

c#基础——了解程序结构
这篇文章主要介绍了c# 程序结构的相关资料，文中讲解非常细致，帮助大家更好的理解和学习C#,感兴趣的朋友可以了解下
2020-07-07
简单的观察者模式示例分享
这篇文章主要介绍了简单的观察者模式示例,抽象层定义了观察者模式,实现层是对抽象层的具体实现,需要的朋友可以参考下
2014-03-03
C#定时器和随机数
在前一篇中我们介绍了键盘和鼠标事件，其实还有一个非常常用的事件，就是定时器事件，如果要对程序实现时间上的控制，那么就要使用到定时器。而随机数也是很常用的一个功能，在我们要想产生一个随机的结果时就要使用到随机数。本文我们就来简单介绍一下定时器和随机数。
2015-06-06
WinForm单例窗体用法实例
这篇文章主要介绍了WinForm单例窗体,结合实例形式分析了窗体的单例模式定义、实现与使用技巧,具有一定参考借鉴价值,需要的朋友可以参考下
2016-07-07
C#实现带行数和标尺的RichTextBox
这篇文章主要为大家详细介绍了如何利用C#实现带行数和标尺的RichTextBox，文中的示例代码讲解详细，对我们学习C#有一定的帮助，感兴趣的小伙伴可以跟随小编一起了解一下
2022-12-12
C#中使用DevExpress中的ChartControl实现极坐标图的案例详解
这篇文章主要介绍了在C#中使用DevExpress中的ChartControl实现极坐标图,本案例是使用的是DevExpress 18.1.3版本，之前在14版本上也试过，但是有一个弊端就是实现极坐标图的时候，第一个点和最后一个点总是自动多一条闭合线，会形成一个闭合的多边形，因此升级了一下版
2022-02-02
C#在线程中访问ui元素的几种实现方法
在C#中,特别是在Windows窗体（WinForms）或WPF应用程序中,直接从非UI线程（如后台工作线程）访问UI元素通常是不被允许的,如果你需要在非UI线程中更新UI元素,本文给大家介绍了C#在线程中访问ui元素的几种实现方法,需要的朋友可以参考下
2024-07-07
泛型编程去掉字段重复数据的方法
这篇文章主要介绍了泛型去掉字段重复数据的方法,大家参考使用吧
2014-01-01
C#中的委托和事件详解
本文详细讲解了C#中的委托和事件，文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2022-07-07
c#图片缩放图片剪切功能实现(等比缩放)
c#图片缩放剪切功能实现，代码中包含了c#图片处理的一些基础知识,与大家分享
2013-12-12