使用 CliWrap 讓C#中的命令行交互(推薦)

Posted on by

在代碼中進行命令行交互是一個很常見的場景, 特別是在一些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", "[email protected]"));

超時和取消

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#命令行交互內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：