ActionsToolkit.Exec 1.0.0

ActionsToolkit.Exec package

To install the ActionsToolkit.Exec NuGet package:

<PackageReference Include="ActionsToolkit.Exec" Version="[Version]" />

Or use the dotnet add package .NET CLI command:

dotnet add package ActionsToolkit.Exec

Get the IExecService instance

IExecService mirrors the upstream @actions/exec Node.js API. Register it with the DI container by calling AddGitHubActionsExec:

using Microsoft.Extensions.DependencyInjection;
using ActionsToolkit.Exec;

using var provider = new ServiceCollection()
    .AddGitHubActionsExec()
    .BuildServiceProvider();

var exec = provider.GetRequiredService<IExecService>();

ExecAsync — run a tool, get its exit code

// Run a tool with no extra args.
int code = await exec.ExecAsync("dotnet --version");

// Pass args separately. Escaping is handled by the runner.
code = await exec.ExecAsync("dotnet", ["--info"]);

By default ExecAsync throws InvalidOperationException when the child returns a non-zero exit code. Set IgnoreReturnCode = true to receive the exit code without throwing.

GetExecOutputAsync — capture stdout / stderr

var output = await exec.GetExecOutputAsync("dotnet", ["--version"]);

Console.WriteLine($"exit code = {output.ExitCode}");
Console.WriteLine($"stdout    = {output.Stdout.Trim()}");
Console.WriteLine($"stderr    = {output.Stderr.Trim()}");

ExecOptions

Listeners

var stdoutChunks = 0;
string? lastErrLine = null;

var options = new ExecOptions
{
    Listeners = new ExecListeners
    {
        Stdout  = data    => stdoutChunks++,
        Stdline = line    => Console.WriteLine($"OUT> {line}"),
        Errline = line    => lastErrLine = line,
        Debug   = message => Console.Error.WriteLine($"[debug] {message}"),
    },
};

await exec.ExecAsync("dotnet", ["--info"], options);

Cancellation

All methods honor CancellationToken. When triggered, the child process tree is killed:

using var cts = new CancellationTokenSource(TimeSpan.FromSeconds(5));

await exec.ExecAsync("some-tool", ["--blocking"], options: null, cts.Token);

Attribution

This package is a .NET port of the official @actions/exec Node.js package by GitHub, licensed under the MIT License. It mirrors the upstream public API surface (exec, getExecOutput, ExecOptions, ExecOutput, ExecListeners) and the ToolRunner quoting/argument-parsing behavior — including libuv's Windows quote_cmd_arg rules and the cmd.exe-specific quoting for .cmd/.bat invocations — where it makes sense in idiomatic .NET.

Tests in tests/ActionsToolkit.Exec.Tests mirror the upstream __tests__/exec.test.ts file, using verbatim it('…') strings as [Fact(DisplayName = "…")] so upstream additions can be tracked over time.