jakoss / CliWrap

Wrapper for command line interfaces

CliWrap

Provides a wrapper around command line interface executables.

Download

• Using nuget: Install-Package CliWrap

Features

• Full abstraction over System.Diagnostics.Process
• Execute commands in a synchronous, asynchronous, fire-and-forget manner
• Pass in command line arguments as well as standard input
• Get process exit code, standard output and standard error as the result
• Stop the execution early using System.Threading.CancellationToken
• Targets .NET Framework 4.5+ and .NET Core 1.0+
• No external dependencies

Usage

Execute a command and get standard output as a string:

var cli = new Cli("some_cli.exe");
string result = cli.Execute("verb --option").StandardOutput;

Execute a command asynchronously:

var cli = new Cli("some_cli.exe");
string result = (await cli.ExecuteAsync("verb --option")).StandardOutput;

Fire and forget:

var cli = new Cli("some_cli.exe");
cli.ExecuteAndForget("verb --option");

Process exit code and standard error:

var cli = new Cli("some_cli.exe");
var output = await cli.ExecuteAsync("verb --option");

int exitCode = output.ExitCode;
string stdErr = output.StandardError;
string stdOut = output.StandardOutput;

// Throw if the CLI reported an error
output.ThrowIfError();

Pass in standard input:

var cli = new Cli("some_cli.exe");
var input = new ExecutionInput("verb --option", "this is stdin");
var output = await cli.ExecuteAsync(input);

Cancel execution:

var cli = new Cli("some_cli.exe");

var cts = new CancellationTokenSource();
cts.CancelAfter(TimeSpan.FromSeconds(1)); // e.g. timeout of 1 second

var output = await cli.ExecuteAsync("verb --option", cts.Token);