feat(sdk): add Go SDK for OpenShell

[rhuss]

Summary

Add a Go SDK that provides typed clients for the OpenShell gateway and edge APIs. The SDK wraps the gRPC transport layer and exposes idiomatic Go types with functional option configuration.

This PR addresses #2044.

Features

• Gateway and Edge API clients with full CRUD operations for sandboxes, providers, services, exec, files, SSH, TCP forwarding, and network policies
• In-memory fakes for testing that mirror real client input validation
• OIDC authentication with automatic token refresh and device-code flow
• Proto generation automation via mise task with CI freshness check
• Fern documentation covering getting started, architecture, error handling, and authentication

File Tree

sdk/go/                              # Go SDK (self-contained module)
├── go.mod                           # Module: github.com/NVIDIA/OpenShell/sdk/go
├── Makefile, mise.toml              # Build configuration
├── openshell/v1/                    # Public API
│   ├── gateway/                     # Gateway client (reads CLI config)
│   ├── edge/                        # Edge API client
│   ├── fake/                        # In-memory test fakes
│   ├── types/                       # Domain types and errors
│   ├── oidc/                        # OIDC authentication
│   └── internal/                    # Proto conversion, gRPC connection
└── proto/                           # Proto definitions + generated .pb.go

docs/sdks/go/                        # Fern MDX documentation
├── getting-started.mdx
├── architecture.mdx
├── error-handling.mdx
└── authentication.mdx

tasks/go.toml                        # Monorepo mise tasks (go:proto, go:lint, etc.)
.github/workflows/branch-checks.yml  # Go CI job added
docs/index.yml                       # SDKs navigation section added

Development Methodology

This SDK was developed using spec-driven development. Design specifications are available in a follow-up PR (#6) for transparency and review.

Testing

• 1035 unit tests pass across 11 packages
• All tests use testify (assert/require)
• Integration tests are gated behind //go:build integration
• In-memory fakes mirror real client validation for test parity

Build & CI

The Go CI job mirrors the existing Rust and Python jobs:

cd sdk/go
mise install --locked
mise run lint          # golangci-lint
mise run build         # go build ./...
mise run test          # go test ./...
mise run proto:check   # Verify generated .pb.go freshness

Examples

The interactive TUI example (oshell) has been extracted to a separate repository: rhuss/openshell-examples. This keeps the upstream SDK library-only.

[coderabbitai]

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 0a367910-adb6-484f-8209-92aa1747930e

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch go-sdk

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[Copilot]

Copilot wasn't able to review this pull request because it exceeds the maximum number of files (300). Try reducing the number of changed files and requesting a review from Copilot again.

[Copilot]

Copilot wasn't able to review this pull request because it exceeds the maximum number of lines (20,000). Try reducing the number of changed lines and requesting a review from Copilot again.

[rhuss]

Closing to recreate with clean diff after rebasing on updated main.