OpenTAP.Runner.Client 4.0.0

.NET 9.0 This package targets .NET 9.0. The package is compatible with this framework or higher.
This package has a SemVer 2.0.0 package version: 4.0.0+44a229b2.
There is a newer prerelease version of this package available.
See the version list below for details.

Requires NuGet 3.3 or higher.

dotnet add package OpenTAP.Runner.Client --version 4.0.0
                    


                    

                
NuGet\Install-Package OpenTAP.Runner.Client -Version 4.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="OpenTAP.Runner.Client" Version="4.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="OpenTAP.Runner.Client" Version="4.0.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="OpenTAP.Runner.Client" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add OpenTAP.Runner.Client --version 4.0.0
                    


                    

                
#r "nuget: OpenTAP.Runner.Client, 4.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. 
#:package OpenTAP.Runner.Client@4.0.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=OpenTAP.Runner.Client&version=4.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=OpenTAP.Runner.Client&version=4.0.0
                    


                            Install as a Cake Tool

OpenTAP Runner Client (C#)

This package provides the asynchronous NATS-based client for talking to an OpenTAP Runner (Runner 2.x).

Quick start

using System.Threading.Tasks;
using OpenTap.Runner.Client;
using OpenTap.Runner.DataTransferObjects.SessionLifecycle;
using OpenTap.Runner.DataTransferObjects.TestPlans;

await using RunnerClient runner = new RunnerClient();  // defaults to nats://127.0.0.1:20111
await runner.ConnectAsync();
SessionClient session = await runner.NewSessionAsync();

RunStatus status = await session.RunTestPlanAsync();
while (status.SessionState != SessionState.Idle)
{
    await Task.Delay(250);
    status = await session.GetStatusAsync();
}

await session.ShutdownAsync(); // or await runner.ShutdownSessionAsync(session.Id);

To connect to a non-default address, pass a URL string or ConnectionOptions to the RunnerClient constructor:

await using RunnerClient runner = new RunnerClient("nats://custom:20111");
await runner.ConnectAsync();

Compatibility

  • Runner Client 4.x (currently in RC) and 3.x target Runner 2.x installations.
  • For Runner 1.x, keep using Runner Client 2.x.

Migrating from 3.x

Runner Client 4.0 contains breaking changes from 3.x, most notably:

  • RunnerClient now owns the NATS connection; construct it directly and call ConnectAsync() instead of creating a NatsConnection yourself. RunnerClient.DefaultUrl moved to ConnectionOptions.DEFAULT_URL.
  • Connect*()/Disconnect*() methods are replaced by C# events (subscribe with +=, unsubscribe with -=).
  • NewSessionAsync() returns a ready-to-use SessionClient; StartSessionAsync() and StartImageSessionAsync() are obsolete.
  • DTOs moved from OpenTap.Runner.Client.Models to namespaces under OpenTap.Runner.DataTransferObjects.

Documentation

Full guides and examples live at https://doc.opentap.io/runner

Product Compatible and additional computed target framework versions.
.NET net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
4.1.0-beta.1 0 7/8/2026
4.0.0 0 7/8/2026
4.0.0-rc.2 0 7/8/2026
4.0.0-rc.1 26 7/3/2026
4.0.0-rc 32 7/3/2026
4.0.0-beta.34 24 7/7/2026
4.0.0-beta.33 20 7/7/2026
4.0.0-beta.32 22 7/7/2026
4.0.0-beta.31 24 7/2/2026
4.0.0-beta.30 23 7/2/2026
4.0.0-beta.29 24 7/2/2026
4.0.0-beta.28 23 7/2/2026
4.0.0-beta.27 26 7/2/2026
4.0.0-beta.26 25 7/2/2026
4.0.0-beta.25 34 6/29/2026
4.0.0-beta.24 36 6/23/2026
4.0.0-beta.23 39 6/23/2026
4.0.0-beta.22 37 6/22/2026
4.0.0-beta.21 39 6/17/2026
4.0.0-beta.20 37 6/16/2026
Loading failed