Groundhog.Protocol 1.0.0

.NET 10.0 This package targets .NET 10.0. The package is compatible with this framework or higher. 
dotnet add package Groundhog.Protocol --version 1.0.0
                    


                    

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


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Groundhog.Protocol" />
                    


                            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 Groundhog.Protocol --version 1.0.0
                    


                    

                
#r "nuget: Groundhog.Protocol, 1.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 Groundhog.Protocol@1.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=Groundhog.Protocol&version=1.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Groundhog.Protocol&version=1.0.0
                    


                            Install as a Cake Tool

Groundhog.Protocol

Shared constants and types for the relay ⇄ agent protocol of Groundhog, the hosted HTTPS tunnel service for local development. The relay and the agent both reference this package, so they agree on every value.

Type What it holds
GroundhogProtocol Protocol version 1, subprotocol groundhog.v1, the connect and health paths
GroundhogHeaders, GroundhogErrors X-Groundhog-* header names and X-Groundhog-Error values
AgentAuthorization The Authorization: <scheme> <token> format and the v1 scheme GroundhogKey
ConnectRefusal Statuses the relay may refuse a connection with, and which ones are permanent
GroundhogCloseCodes WebSocket close codes, and which ones stop the agent
ConnectionPool Pool size bounds, ping interval and silence timeout
ReconnectBackoff The reconnect schedule (1, 2, 4, 8 … 30 s, with jitter) as a pure function
TunnelName Tunnel-name rules and the default reserved names
ConnectionKey Connection key (the agent's credential) generation, SHA-256 hashing and constant-time verification
WebSocketDuplexStream A WebSocket as a duplex Stream, for HTTP/2 to run over
HealthResponse The health endpoint's JSON body
VisitorAccessDeclaration, VisitorAccessRule, VisitorAccessPathRule A tunnel's visitor access rules as an agent declares them, with base64url JSON encoding
VisitorAccessValidator, VisitorAccessMethods The shared validation rules and limits, and the allow values (anyone, members, apikeys, ips)
ApiKey API key generation and SHA-256 hashing: the keys callers send to reach a path, not the agent's connection key

The protocol itself is described in docs/protocol.md in the source repository (linked from this package's project page).

MIT licensed.

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  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.

  • net10.0

    • No dependencies.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Groundhog.Protocol:

Package Downloads
Groundhog.Agent

The Groundhog agent as a library: keeps a tunnel connected to the Groundhog service and forwards its requests to a local app.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.0 38 10/17/2026
0.4.0-preview.7 50 10/14/2026
0.4.0-preview.6 40 10/14/2026
0.4.0-preview.5 55 10/13/2026
0.4.0-preview.4 54 10/13/2026
0.4.0-preview.3 50 10/13/2026
0.4.0-preview.2 134 10/13/2026
0.4.0-preview.1 63 10/12/2026
0.3.0-preview.3 113 10/11/2026
0.3.0-preview.2 62 10/11/2026
0.3.0-preview.1 69 10/11/2026
0.2.0-preview.4 75 10/10/2026
0.2.0-preview.3 73 10/10/2026
0.2.0-preview.2 61 10/10/2026
0.2.0-preview.1 59 10/10/2026