SimpleExec 12.0.0

dotnet add package SimpleExec --version 12.0.0
NuGet\Install-Package SimpleExec -Version 12.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="SimpleExec" Version="12.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add SimpleExec --version 12.0.0
#r "nuget: SimpleExec, 12.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install SimpleExec as a Cake Addin
#addin nuget:?package=SimpleExec&version=12.0.0

// Install SimpleExec as a Cake Tool
#tool nuget:?package=SimpleExec&version=12.0.0

SimpleExec

SimpleExec

NuGet version

Build status CodeQL analysis lint Spell check

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.

Platform support: .NET 6.0 and later.

Quick start

using static SimpleExec.Command;
Run("foo", "arg1 arg2");

Run

Run("foo");
Run("foo", "arg1 arg2");
Run("foo", new[] { "arg1", "arg2" });

await RunAsync("foo");
await RunAsync("foo", "arg1 arg2");
await RunAsync("foo", new[] { "arg1", "arg2" });

By default, the command is echoed to standard output (stdout) for visibility.

Read

var (standardOutput1, standardError1) = await ReadAsync("foo");
var (standardOutput2, standardError2) = await ReadAsync("foo", "arg1 arg2");
var (standardOutput3, standardError3) = await ReadAsync("foo", new[] { "arg1", "arg2" });

Other optional arguments

string workingDirectory = "",
bool noEcho = false,
string? echoPrefix = null,
Action<IDictionary<string, string?>>? configureEnvironment = null,
bool createNoWindow = false,
Encoding? encoding = null,
Func<int, bool>? handleExitCode = null,
string? standardInput = null,
bool cancellationIgnoresProcessTree = false,
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

Most programs return a zero exit code when they succeed and a non-zero exit code fail. However, there are some programs which return a non-zero exit code when they succeed. For example, Robocopy returns an exit code less than 8 when it succeeds and 8 or greater when a failure occurs.

The throwing of exceptions for specific non-zero exit codes may 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, when running Robocopy, exception throwing should be suppressed for an exit code less than 8:

Run("ROBOCOPY", "from to", handleExitCode: code => code < 8);

Note that it may be useful to record the exit code. For example:

var exitCode = 0;
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;

<sub>Run by Gregor Cresnar from the Noun Project.</sub>

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  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 is compatible.  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 is compatible.  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. 
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.
  • net6.0

    • No dependencies.
  • net7.0

    • No dependencies.
  • net8.0

    • No dependencies.

NuGet packages (6)

Showing the top 5 NuGet packages that depend on SimpleExec:

Package Downloads
Vertiq.Testing.XUnit

A highly modular Framework to write Blazor Applications with a husstle free vertical sliced architecture - Easy. Flexible. Focused.

Xenial.Beer

Beer - Delicious dotnet build tools

Quick.Build

A lot of utils for build.

ILVerifier

A simple helper library to access provider-specific types when working with IDbConnection and friends.

LanceC.Tooling.DevOps

Provides DevOps tooling infrastructure.

GitHub repositories (42)

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.
JasperFx/marten
.NET Transactional Document DB and Event Store on PostgreSQL
aaubry/YamlDotNet
YamlDotNet is a .NET library for YAML
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 15,972 1/15/2024
12.0.0-rc.1 359 12/25/2023
12.0.0-beta.1 217 12/24/2023
12.0.0-alpha.1 1,923 6/9/2023
11.0.0 336,673 8/21/2022
11.0.0-rc.1 570 7/22/2022
10.0.0 131,971 3/26/2022
10.0.0-beta.2 16,235 3/20/2022
10.0.0-beta.1 225 3/19/2022
9.1.0 14,307 3/19/2022
9.1.0-rc.1 199 3/13/2022
9.1.0-alpha.1 209 3/12/2022
9.0.0 4,134 3/12/2022
9.0.0-rc.4 1,198 2/26/2022
9.0.0-rc.3 7,664 12/30/2021
9.0.0-rc.2 255 12/23/2021
9.0.0-rc.1 159 12/23/2021
9.0.0-alpha.1 14,896 8/22/2021
8.0.0 439,773 7/5/2021
8.0.0-rc.1 449 6/26/2021
8.0.0-alpha.8 203 6/20/2021
8.0.0-alpha.7 170 6/19/2021
8.0.0-alpha.6 198 6/19/2021
8.0.0-alpha.5 197 6/19/2021
8.0.0-alpha.4 226 6/19/2021
8.0.0-alpha.3 921 6/13/2021
8.0.0-alpha.2 394 6/12/2021
8.0.0-alpha.1 235 6/12/2021
7.0.0 72,902 3/14/2021
7.0.0-alpha.2 298 3/13/2021
7.0.0-alpha.1 4,324 12/20/2020
6.4.0 66,207 12/20/2020
6.4.0-rc.1 1,542 12/5/2020
6.3.0 37,414 10/26/2020
6.2.0 233,493 12/21/2019
6.2.0-rc.1 1,321 12/15/2019
6.1.0 62,114 10/13/2019
6.1.0-rc.1 1,596 9/8/2019
6.1.0-beta.1 845 8/27/2019
6.0.0 52,023 7/13/2019
6.0.0-rc.1 406 6/27/2019
6.0.0-beta.1 647 6/12/2019
6.0.0-alpha.1 445 6/1/2019
5.0.1 19,351 2/10/2019
5.0.1-rc.1 594 2/10/2019
5.0.0 351 2/9/2019
5.0.0-beta.1 944 2/5/2019
5.0.0-alpha.2 338 2/4/2019
5.0.0-alpha.1 630 1/3/2019
4.2.0 17,894 12/8/2018
4.1.0 2,322 12/2/2018
4.0.0 372 11/27/2018
4.0.0-rc.1 409 11/26/2018
4.0.0-beta.1 700 11/20/2018
3.0.0 22,879 9/20/2018
2.3.0 2,197 8/25/2018
2.3.0-beta.1 442 8/11/2018
2.2.0 1,582 6/26/2018
2.1.0 1,361 5/20/2018
2.0.0 1,416 11/12/2017
1.0.0 2,189 11/5/2017