使用 CliWrap 让C#中的命令行交互(推荐)

 更新时间:2021年12月31日 10:14:36   作者:SpringLeee  
这篇文章主要介绍了使用 CliWrap 让C#中的命令行交互举重若轻,这是一个在 .NET 平台使用的命令行交互工具库, 通过在C# 中使用 Fluent 的API, 让命令行交互,感兴趣的朋友跟随小编一起看看吧

在代码中进行命令行交互是一个很常见的场景, 特别是在一些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# WPF开源UI控件库MaterialDesign介绍

    C# WPF开源UI控件库MaterialDesign介绍

    这篇文章介绍了C# WPF开源UI控件库MaterialDesign,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-01-01
  • C#实现回文检测的方法

    C#实现回文检测的方法

    这篇文章主要介绍了C#实现回文检测的方法,实例分析了C#使用栈进行回文检测的相关技巧,具有一定参考借鉴价值,需要的朋友可以参考下
    2015-04-04
  • C#批量插入数据到Sqlserver中的三种方式

    C#批量插入数据到Sqlserver中的三种方式

    这篇文章主要为大家详细介绍了C#批量插入数据到Sqlserver中的三种方式,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-12-12
  • C#通过DataSet读写xml文件的方法

    C#通过DataSet读写xml文件的方法

    这篇文章主要介绍了C#通过DataSet读写xml文件的方法,涉及C#使用DataSet操作XML的相关技巧,方法简单实用,需要的朋友可以参考下
    2015-05-05
  • 你是不是这样写异常处理代码的呢?

    你是不是这样写异常处理代码的呢?

    本篇文章是对,你是不是这样写异常处理代码的进行了详细的分析介绍,需要的朋友参考下
    2013-05-05
  • C#图表算法之无向图

    C#图表算法之无向图

    这篇文章介绍了C#图表算法之无向图,文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-04-04
  • C#使用Aforge调用摄像头拍照的方法

    C#使用Aforge调用摄像头拍照的方法

    这篇文章主要为大家详细介绍了C#使用Aforge调用摄像头拍照的方法,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-10-10
  • C#中的IEnumerable简介及简单实现实例

    C#中的IEnumerable简介及简单实现实例

    这篇文章主要介绍了C#中的IEnumerable简介及简单实现实例,本文讲解了IEnumerable一些知识并给出了一个简单的实现,需要的朋友可以参考下
    2015-03-03
  • c#生成自定义图片方法代码实例

    c#生成自定义图片方法代码实例

    在本篇文章中我们给大家分享了关于c#生成自定义图片方法的相关内容,有需要的朋友们可以参考下。
    2018-10-10
  • C#向图片添加水印的两种不同场景与解决方法

    C#向图片添加水印的两种不同场景与解决方法

    这篇文章给大家介绍了两种大家可能需要的功能,利用C#实现不同需求的向图片添加水印的方法,文章通过效果图和示例代码介绍的很详细,有需要的朋友们可以参考借鉴。
    2016-09-09

最新评论