DevTunnels.Client 1.0.2

DevTunnels.Client

Async-first .NET 10 client library for Azure Dev Tunnels, wrapping the devtunnel CLI with a typed, cancellation-aware API.

Packages

Requirements

The devtunnel CLI must be installed. The library searches the following locations in order:

1. DevTunnelsClientOptions.CliPathOverride — explicit path set in code
2. DEVTUNNEL_CLI_PATH environment variable
3. Well-known install paths (checked by default, no PATH entry required):
   • Windows — %LOCALAPPDATA%\Microsoft\DevTunnels\, ~/.devtunnels/bin/, ~/bin/
   • macOS — /opt/homebrew/bin/ (Homebrew), /usr/local/bin/, ~/bin/
   • Linux — ~/.local/bin/, ~/bin/, /usr/local/bin/
4. System PATH

Minimum CLI version: 1.0.1435

The library enforces this at startup. If the installed CLI is older, ProbeCliAsync() returns MeetsMinimumVersion = false and operations that require the CLI will throw.

Check your installed version:

devtunnel --version
# expected output: Tunnel CLI version: 1.0.1435+<commit>

The library was developed and integration-tested against 1.0.1435. Later versions are expected to be compatible; earlier versions are not supported.

The minimum can be overridden per-instance via DevTunnelsClientOptions.MinimumSupportedVersion if you need to pin a different floor.

Install / update:

# Windows
winget install Microsoft.DevTunnel
# or update an existing install:
winget upgrade Microsoft.DevTunnel

# macOS
brew install devtunnel
# or update:
brew upgrade devtunnel

# Linux / other
curl -sL https://aka.ms/DevTunnelCliInstall | bash

Or follow the official install guide.

Install

dotnet add package DevTunnels.Client
dotnet add package DevTunnels.Client.DependencyInjection  # optional

Quick Start

using DevTunnels.Client;

var client = new DevTunnelsClient(new DevTunnelsClientOptions
{
    CommandTimeout = TimeSpan.FromSeconds(15)
});

// Check CLI is available
var probe = await client.ProbeCliAsync();
Console.WriteLine($"devtunnel {probe.Version} installed: {probe.IsInstalled}");

// Login
await client.LoginAsync(LoginProvider.GitHub);

// Create a persistent tunnel with a port
await client.CreateOrUpdateTunnelAsync("my-tunnel", new DevTunnelOptions
{
    Description = "My development tunnel",
    AllowAnonymous = true,
});
await client.CreateOrReplacePortAsync("my-tunnel", 5000, new DevTunnelPortOptions
{
    Protocol = "http",  // devtunnel terminates TLS; local service speaks plain HTTP
});

// Host the tunnel and wait for it to be ready
using var session = await client.StartHostSessionAsync(
    new DevTunnelHostStartOptions { TunnelId = "my-tunnel" },
    CancellationToken.None);

await session.WaitForReadyAsync(CancellationToken.None);
Console.WriteLine($"Public URL: {session.PublicUrl}");

// Keep alive until cancelled
await session.WaitForExitAsync(CancellationToken.None);

Dependency Injection

using DevTunnels.Client.DependencyInjection;
using Microsoft.Extensions.Hosting;

var builder = Host.CreateApplicationBuilder(args);

builder.Services.AddDevTunnelsClient(options =>
{
    options.CommandTimeout = TimeSpan.FromSeconds(15);
});

API Surface

Authentication

Tunnels

Ports

Access

Host Session

Escape Hatch

// Run any devtunnel command and capture stdout/stderr
var result = await client.ExecuteRawAsync(["user", "show", "--json", "--nologo"]);
Console.WriteLine(result.StandardOutput);

Repository Layout

src/
  DevTunnels.Client/                      # core library
  DevTunnels.Client.DependencyInjection/  # IServiceCollection helpers
tests/
  DevTunnels.Client.Tests/                # unit tests
examples/
  DevTunnels.Client.Example/              # interactive CLI sample (Spectre.Console)

Build

dotnet restore DevTunnels.Client.slnx
dotnet build DevTunnels.Client.slnx -c Release
dotnet test DevTunnels.Client.slnx -c Release --no-build

License

MIT. See LICENSE.txt.