您好,登錄后才能下訂單哦!
小編給大家分享一下怎么使用CliWrap讓C#中的命令行交互,希望大家閱讀完這篇文章之后都有所收獲,下面讓我們一起去探討吧!
在代碼中進(jìn)行命令行交互是一個(gè)很常見的場景, 特別是在一些CI CD 自動(dòng)化流程中, 在這之前我們會(huì)使用 System.Diagnostics.Process
API, 現(xiàn)在有一個(gè)更靈活的工具 CliWarp, 這是一個(gè)在 .NET 平臺(tái)使用的命令行交互工具庫, 通過在C# 中使用 Fluent 的API, 讓命令行交互舉重若輕。
https://github.com/Tyrrrz/CliWrap
主要特性如下:
基于 System.Diagnostics.Process
簡單, 流暢的 API 設(shè)計(jì)
靈活的支持管道模式
安全異步并且支持 cancellation API
跨平臺(tái), 可在 Windows、Linux 和 macOS 使用
支持 .NET Standard 2.0+、.NET Core 3.0+、.NET Framework 4.6.1+
和 shell 是類似的,CliWrap 的基本工作單元是一個(gè) command
, 首先會(huì)執(zhí)行 Cli.Wrap(...) 創(chuàng)建 command, 參數(shù)是可執(zhí)行文件的路徑, 然后通過 fluent api 配置, 最后調(diào)用 ExecuteAsync
運(yùn)行命令,如下:
using CliWrap; using CliWrap.Buffered; var result = await Cli.Wrap("path/to/exe") //.... .ExecuteBufferedAsync();
配置參數(shù)
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));
配置工作目錄
默認(rèn)是當(dāng)前目錄, 你也可以指定文件夾的相對路徑和絕對路徑
var cmd = Cli.Wrap("git") .WithWorkingDirectory("c:/projects/my project/");
配置環(huán)境變量
var cmd = Cli.Wrap("git") .WithEnvironmentVariables(env => env .Set("GIT_AUTHOR_NAME", "John") .Set("GIT_AUTHOR_EMAIL", "john@email.com"));
超時(shí)和取消
using var cts = new CancellationTokenSource(); cts.CancelAfter(TimeSpan.FromSeconds(10)); var result = await Cli.Wrap("path/to/exe").ExecuteAsync(cts.Token);
基于拉取的事件流
除了執(zhí)行命令之外,CliWrap 還支持事件流模型, 可以訂閱相關(guān)的事件回調(diào)。
StartedCommandEvent -- 僅接收一次,當(dāng)命令開始執(zhí)行時(shí)(包含 process ID)
StandardOutputCommandEvent -- 每次底層進(jìn)程向輸出流寫入新行時(shí)收到(包含文本作為字符串)
StandardErrorCommandEvent -- 每次底層進(jìn)程向錯(cuò)誤流寫入新行時(shí)收到(包含文本作為字符串)
ExitedCommandEvent -- 僅接收一次,當(dāng)命令完成執(zhí)行時(shí)(包含 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; } }
輸出結(jié)果如下:
看完了這篇文章,相信你對“怎么使用CliWrap讓C#中的命令行交互”有了一定的了解,如果想了解更多相關(guān)知識(shí),歡迎關(guān)注億速云行業(yè)資訊頻道,感謝各位的閱讀!
免責(zé)聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點(diǎn)不代表本網(wǎng)站立場,如果涉及侵權(quán)請聯(lián)系站長郵箱:is@yisu.com進(jìn)行舉報(bào),并提供相關(guān)證據(jù),一經(jīng)查實(shí),將立刻刪除涉嫌侵權(quán)內(nèi)容。