CliWrap is a library that makes it easier to interact with command line interfaces. It provides a convenient wrapper around the target executable, allowing you to pass execution parameters and read the resulting output. The library can also handle errors reported by the underlying process, allows command cancellation and has both synchronous and asynchronous APIs.
- Using nuget:
Install-Package CliWrap
- Full abstraction over
System.Diagnostics.Process - Execute commands in a synchronous, asynchronous, fire-and-forget manner
- Pass in command line arguments, standard input and environment variables
- 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+, .NET Core 1.0+ and .NET Standard 2.0+
- No external dependencies
Execute a command and process output:
// Setup
var cli = new Cli("some_cli.exe");
// Execute
var output = await cli.ExecuteAsync("command --option");
// ... or in synchronous manner:
// var output = cli.Execute("command --option");
// Throw an exception if CLI reported an error
output.ThrowIfError();
// Process output
var code = output.ExitCode;
var stdOut = output.StandardOutput;
var stdErr = output.StandardError;Execute a command without waiting for completion:
var cli = new Cli("some_cli.exe");
cli.ExecuteAndForget("command --option");Pass in standard input:
var cli = new Cli("some_cli.exe");
var input = new ExecutionInput("command --option", "this is stdin");
var output = await cli.ExecuteAsync(input);Pass in environment variables:
var cli = new Cli("some_cli.exe");
var input = new ExecutionInput("command --option");
input.EnvironmentVariables.Add("some_var", "some_value");
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("command --option", cts.Token);