使用 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#命令行交互内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Unity UGUI教程之实现滑页效果

    Unity UGUI教程之实现滑页效果

    使用UGUI提供的ScrollRect和ScrollBar组件实现基本滑动以及自己控制每次移动一页来达到滑页的效果。具体实现思路请参考下本教程
    2016-04-04
  • C# 中类型转换方式之显式转换和 as 运算符

    C# 中类型转换方式之显式转换和 as 运算符

    在 C# 中,有两种常见的类型转换方式:显式转换和as 运算符,它们用于在不同类型之间进行转换,以下是对这两种转换方式的详细解释和示例说明,感兴趣的朋友跟随小编一起看看吧
    2024-05-05
  • c# 重载WndProc,实现重写“最小化”的实现方法

    c# 重载WndProc,实现重写“最小化”的实现方法

    在做“亦歌桌面版”的时候,发现当打开歌词状态下,用最小化隐藏窗体到托盘的话(如下code #1),在调出发现歌词缩小了(虽然显现的窗体大小跟刚才一样),从这点看调用该方法其实窗体大小是改变了的(这个过程只是不可视而已)。
    2009-02-02
  • WPF/Silverlight实现图片局部放大的方法分析

    WPF/Silverlight实现图片局部放大的方法分析

    这篇文章主要介绍了WPF/Silverlight实现图片局部放大的方法,结合实例形式分析了WPF/Silverlight针对图片属性操作相关实现技巧,需要的朋友可以参考下
    2017-03-03
  • C#二叉搜索树插入算法实例分析

    C#二叉搜索树插入算法实例分析

    这篇文章主要介绍了C#二叉搜索树插入算法,实例分析了C#二叉树操作的相关技巧,需要的朋友可以参考下
    2015-04-04
  • 浅谈Unity脚本生命周期与执行顺序

    浅谈Unity脚本生命周期与执行顺序

    在Unity中,脚本可以理解为附加在游戏对象上的用于定义游戏对象行为的指令代码。必须绑定在游戏对象上才能开始它的生命周期。游戏对象可以理解为能容纳各种组件的容器,游戏对象的所有组件一起决定了这个对象的行为和游戏中的表现
    2021-06-06
  • 在C#中如何使用ResNet50v2进行图像识别

    在C#中如何使用ResNet50v2进行图像识别

    ONNX 运行时推理可以实现更快的客户体验和更低的成本,支持来自深度学习框架如 PyTorch和TensorFlow/Keras以及经典机器学习库如 scikit-learn、LightGBM、XGBoost 等的模型,这篇文章主要介绍了在C#中如何使用ResNet50v2进行图像识别,需要的朋友可以参考下
    2024-07-07
  • C# 实现特殊字符快速转码

    C# 实现特殊字符快速转码

    这篇文章主要介绍了C# 实现特殊字符快速转码,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2021-01-01
  • C#关于类的只读只写属性实例分析

    C#关于类的只读只写属性实例分析

    这篇文章主要介绍了C#关于类的只读只写属性实例分析,对于初学者更好的理解类的只读只写属性有一定的帮助,需要的朋友可以参考下
    2014-07-07
  • C#数组学习相关资料整理

    C#数组学习相关资料整理

    最近开始学习c#,并有幸接触到了数组方便的操作,感觉确实不错,这里简单的整理下c#相关的学习资料,方便大家学习
    2012-09-09

最新评论