SimpleExec 9.0.0-rc.4
See the version list below for details.
dotnet add package SimpleExec --version 9.0.0-rc.4
NuGet\Install-Package SimpleExec -Version 9.0.0-rc.4
<PackageReference Include="SimpleExec" Version="9.0.0-rc.4" />
paket add SimpleExec --version 9.0.0-rc.4
#r "nuget: SimpleExec, 9.0.0-rc.4"
// Install SimpleExec as a Cake Addin #addin nuget:?package=SimpleExec&version=9.0.0-rc.4&prerelease // Install SimpleExec as a Cake Tool #tool nuget:?package=SimpleExec&version=9.0.0-rc.4&prerelease
SimpleExec
SimpleExec is a .NET library that runs external commands. It wraps System.Diagnostics.Process
to make things easier.
SimpleExec intentionally does not invoke the system shell.
By default, the command is echoed to standard error (stderr) for visibility.
Platform support: .NET Standard 2.1 and later.
Quick start
using static SimpleExec.Command;
Run("foo.exe", "arg1 arg2");
API
Run
Run("foo.exe");
Run("foo.exe", "arg1 arg2", "my-working-directory");
await RunAsync("foo.exe");
await RunAsync("foo.exe", "arg1 arg2", "my-working-directory");
Read
var (standardOutput1, standardError1) = await ReadAsync("foo.exe");
var (standardOutput2, standardError2) = await ReadAsync("foo.exe", "arg1 arg2", "my-working-directory");
Other optional arguments
bool noEcho = false,
string? windowsName = null,
string? windowsArgs = null,
string? echoPrefix = null,
Action<IDictionary<string, string>>? configureEnvironment = null,
bool createNoWindow = false,
Func<int, bool>? handleExitCode = null,
CancellationToken cancellationToken = default,
Exceptions
If the command has a non-zero exit code, an ExitCodeException
is thrown with an int
ExitCode
property and a message in the form of:
$"The process exited with code {ExitCode}."
In the case of ReadAsync
, an ExitCodeReadException
is thrown, which inherits from ExitCodeException
, and has string
Out
and Error
properties, representing standard out (stdout) and standard error (stderr), and a message in the form of:
$@"The process exited with code {ExitCode}.
Standard Output:
{Out}
Standard Error:
{Error}"
Overriding default exit code handling
The throwing of exceptions for specific non-zero exit codes can be suppressed by passing a delegate to handleExitCode
which returns true
when it has handled the exit code and default exit code handling should be suppressed, and returns false
otherwise. For example:
Run("ROBOCOPY", "from to", handleExitCode: code => code < 8);
Note that it may be useful to record the exit code. For example:
var exitCode = 0;
var result = Run("ROBOCOPY", "from to", handleExitCode: code => (exitCode = code) < 8);
// see https://ss64.com/nt/robocopy-exit.html
var oneOrMoreFilesCopied = exitCode & 1;
var extraFilesOrDirectoriesDetected = exitCode & 2;
var misMatchedFilesOrDirectoriesDetected = exitCode & 4;
Windows
🙄
Sometimes, for whatever wonderful reasons, it's necessary to run a different command on Windows. For example, when running Yarn, some combination of mysterious factors may require that you explicitly run cmd.exe
with Yarn as an argument, rather than running Yarn directly. The optional windowsNames
and windowsArgs
parameters may be used to specify a different command name and arguments for Windows:
Run("yarn", windowsName: "cmd", windowsArgs: "/c yarn");
<sub>Run by Gregor Cresnar from the Noun Project.</sub>
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.1 is compatible. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.1
- No dependencies.
NuGet packages (11)
Showing the top 5 NuGet packages that depend on SimpleExec:
Package | Downloads |
---|---|
Vertiq.Testing.XUnit
A highly modular framework for writing Blazor applications with a hassle-free, vertical-sliced architecture - Easy. Flexible. Focused. |
|
Xenial.Beer
Beer - Delicious dotnet build tools |
|
Quick.Build
A lot of utils for build. |
|
ZYC.AutomationTools
Package Description |
|
ILVerifier
A simple helper library to access provider-specific types when working with IDbConnection and friends. |
GitHub repositories (41)
Showing the top 5 popular GitHub repositories that depend on SimpleExec:
Repository | Stars |
---|---|
IdentityServer/IdentityServer4
OpenID Connect and OAuth 2.0 Framework for ASP.NET Core
|
|
xunit/xunit
xUnit.net is a free, open source, community-focused unit testing tool for .NET.
|
|
aaubry/YamlDotNet
YamlDotNet is a .NET library for YAML
|
|
adamhathcock/sharpcompress
SharpCompress is a fully managed C# library to deal with many compression types and formats.
|
|
AppMetrics/AppMetrics
App Metrics is an open-source and cross-platform .NET library used to record and report metrics within an application.
|
Version | Downloads | Last updated |
---|---|---|
12.0.0 | 227,281 | 1/15/2024 |
12.0.0-rc.1 | 412 | 12/25/2023 |
12.0.0-beta.1 | 251 | 12/24/2023 |
12.0.0-alpha.1 | 1,985 | 6/9/2023 |
11.0.0 | 446,706 | 8/21/2022 |
11.0.0-rc.1 | 612 | 7/22/2022 |
10.0.0 | 148,657 | 3/26/2022 |
10.0.0-beta.2 | 20,971 | 3/20/2022 |
10.0.0-beta.1 | 250 | 3/19/2022 |
9.1.0 | 16,026 | 3/19/2022 |
9.1.0-rc.1 | 226 | 3/13/2022 |
9.1.0-alpha.1 | 239 | 3/12/2022 |
9.0.0 | 4,430 | 3/12/2022 |
9.0.0-rc.4 | 1,229 | 2/26/2022 |
9.0.0-rc.3 | 9,250 | 12/30/2021 |
9.0.0-rc.2 | 278 | 12/23/2021 |
9.0.0-rc.1 | 190 | 12/23/2021 |
9.0.0-alpha.1 | 19,850 | 8/22/2021 |
8.0.0 | 567,761 | 7/5/2021 |
8.0.0-rc.1 | 470 | 6/26/2021 |
8.0.0-alpha.8 | 225 | 6/20/2021 |
8.0.0-alpha.7 | 197 | 6/19/2021 |
8.0.0-alpha.6 | 224 | 6/19/2021 |
8.0.0-alpha.5 | 217 | 6/19/2021 |
8.0.0-alpha.4 | 254 | 6/19/2021 |
8.0.0-alpha.3 | 941 | 6/13/2021 |
8.0.0-alpha.2 | 415 | 6/12/2021 |
8.0.0-alpha.1 | 256 | 6/12/2021 |
7.0.0 | 74,353 | 3/14/2021 |
7.0.0-alpha.2 | 329 | 3/13/2021 |
7.0.0-alpha.1 | 4,361 | 12/20/2020 |
6.4.0 | 70,315 | 12/20/2020 |
6.4.0-rc.1 | 1,561 | 12/5/2020 |
6.3.0 | 42,051 | 10/26/2020 |
6.2.0 | 271,202 | 12/21/2019 |
6.2.0-rc.1 | 1,335 | 12/15/2019 |
6.1.0 | 64,626 | 10/13/2019 |
6.1.0-rc.1 | 1,609 | 9/8/2019 |
6.1.0-beta.1 | 855 | 8/27/2019 |
6.0.0 | 54,156 | 7/13/2019 |
6.0.0-rc.1 | 422 | 6/27/2019 |
6.0.0-beta.1 | 666 | 6/12/2019 |
6.0.0-alpha.1 | 455 | 6/1/2019 |
5.0.1 | 20,046 | 2/10/2019 |
5.0.1-rc.1 | 608 | 2/10/2019 |
5.0.0 | 364 | 2/9/2019 |
5.0.0-beta.1 | 960 | 2/5/2019 |
5.0.0-alpha.2 | 347 | 2/4/2019 |
5.0.0-alpha.1 | 640 | 1/3/2019 |
4.2.0 | 17,963 | 12/8/2018 |
4.1.0 | 2,339 | 12/2/2018 |
4.0.0 | 388 | 11/27/2018 |
4.0.0-rc.1 | 426 | 11/26/2018 |
4.0.0-beta.1 | 719 | 11/20/2018 |
3.0.0 | 23,149 | 9/20/2018 |
2.3.0 | 2,373 | 8/25/2018 |
2.3.0-beta.1 | 468 | 8/11/2018 |
2.2.0 | 1,708 | 6/26/2018 |
2.1.0 | 1,526 | 5/20/2018 |
2.0.0 | 1,550 | 11/12/2017 |
1.0.0 | 3,507 | 11/5/2017 |