Table of Contents

API reference

Generated from the XML documentation of the three packages, for the net10.0 build (the net8.0 build has the same API).

Namespace Package Contents
OpenShell OpenShell.Net The client (OpenShellClient, IOpenShellClient), the per-area clients, models, options, authentication, retries, errors, telemetry.
OpenShell.Gateway OpenShell.Net Gateways registered by the OpenShell CLI: GatewayClient, GatewayLocator.
OpenShell.Oidc OpenShell.Net OIDC login, device code, refresh, and client credentials.
OpenShell.Edge OpenShell.Net The Cloudflare Access edge tunnel.
Microsoft.Extensions.DependencyInjection OpenShell.Net.DependencyInjection AddOpenShell, AddOpenShellClient, and the health check registration.
OpenShell.DependencyInjection OpenShell.Net.DependencyInjection Options and the client factory.
OpenShell.Testing OpenShell.Net.Testing FakeOpenShellClient and FakeGateway.
Openshell.V1, Openshell.Sandbox.V1, Openshell.Datamodel.V1, Openshell.Options.V1 OpenShell.Net The generated protobuf messages and gRPC clients, used by policies and raw access. Their documentation comes from the .proto files.