---
title: Overview
url: /docs/sdks/go/0.1.7/api/overview/
docset: sdk-go
version: 0.1.7
latest_version: 0.1.9
source: ai-openshell/sdk-go@v0.1.7:docs/src/api/overview.md
---

> Documentation index: /docs/sdks/go/0.1.7/llms.txt. This page is for Go SDK 0.1.7.
> This is not the latest version. Latest (0.1.9): /docs/sdks/go/api/overview.md

# Overview

The OpenShell Go SDK exposes typed interfaces through the sub-client pattern.
You access each interface through a typed accessor on the concrete `Client`.

## Interface Summary

### Top-Level Interfaces

| Interface                                                              | Accessor                    | Description                                       |
| ---------------------------------------------------------------------- | --------------------------- | ------------------------------------------------- |
| [SandboxInterface](/docs/sdks/go/0.1.7/api/sandboxes/)                 | `client.Sandboxes()`        | Create, manage, and watch sandbox lifecycle       |
| [SandboxTemplateInterface](/docs/sdks/go/0.1.7/api/sandbox-templates/) | `client.SandboxTemplates()` | Manage reusable sandbox templates                 |
| [ExecInterface](/docs/sdks/go/0.1.7/api/exec/)                         | `client.Exec()`             | Run commands, stream output, interactive sessions |
| [ProviderInterface](/docs/sdks/go/0.1.7/api/providers/)                | `client.Providers()`        | Manage compute providers and their lifecycle      |
| [ServiceInterface](/docs/sdks/go/0.1.7/api/services/)                  | `client.Services()`         | Expose and manage HTTP services inside sandboxes  |
| [FileInterface](/docs/sdks/go/0.1.7/api/files/)                        | `client.Files()`            | Upload and download files to/from sandboxes       |
| [HealthInterface](/docs/sdks/go/0.1.7/api/health/)                     | `client.Health()`           | Check gateway health status                       |
| [SSHInterface](/docs/sdks/go/0.1.7/api/ssh/)                           | `client.SSH()`              | Create SSH sessions and tunnels to sandboxes      |
| [TCPInterface](/docs/sdks/go/0.1.7/api/tcp/)                           | `client.TCP()`              | Forward TCP connections to sandbox ports          |
| [ConfigInterface](/docs/sdks/go/0.1.7/api/config/)                     | `client.Config()`           | Read and update sandbox and gateway configuration |
| [PolicyInterface](/docs/sdks/go/0.1.7/api/policy/)                     | `client.Policy()`           | Manage draft policy recommendations               |

### Convenience Packages

| Package                                     | Entry Point               | Description                                    |
| ------------------------------------------- | ------------------------- | ---------------------------------------------- |
| [gateway](/docs/sdks/go/0.1.7/api/gateway/) | `gateway.NewClient(name)` | Read CLI gateway configs and auto-wire clients |

### Provider Sub-Interfaces

These are accessed through `client.Providers()`:

| Interface                                             | Accessor                        | Description                             |
| ----------------------------------------------------- | ------------------------------- | --------------------------------------- |
| [ProfileInterface](/docs/sdks/go/0.1.7/api/profiles/) | `client.Providers().Profiles()` | Manage provider type profiles           |
| [RefreshInterface](/docs/sdks/go/0.1.7/api/refresh/)  | `client.Providers().Refresh()`  | Configure credential refresh strategies |

## Interfaces

Each interface has a reference page with method signatures and usage examples:

- **[Sandboxes](/docs/sdks/go/0.1.7/api/sandboxes/)**: Create sandboxes, wait for readiness, watch state changes, manage providers, retrieve logs.
- **[Sandbox Templates](/docs/sdks/go/0.1.7/api/sandbox-templates/)**: Create reusable workload templates and launch sandboxes from them.
- **[Exec](/docs/sdks/go/0.1.7/api/exec/)**: Execute commands with one-shot, streaming, or interactive modes.
- **[Providers](/docs/sdks/go/0.1.7/api/providers/)**: Register and manage compute providers. Includes sub-clients for profiles and credential refresh.
- **[Services](/docs/sdks/go/0.1.7/api/services/)**: Expose and manage HTTP services inside sandboxes.
- **[Files](/docs/sdks/go/0.1.7/api/files/)**: Upload and download files to/from sandboxes.
- **[Health](/docs/sdks/go/0.1.7/api/health/)**: Check gateway health status.
- **[SSH](/docs/sdks/go/0.1.7/api/ssh/)**: Create SSH sessions and tunnels to sandboxes.
- **[TCP](/docs/sdks/go/0.1.7/api/tcp/)**: Forward TCP connections to sandbox ports.
- **[Config](/docs/sdks/go/0.1.7/api/config/)**: Read and update sandbox and gateway configuration.
- **[Policy](/docs/sdks/go/0.1.7/api/policy/)**: Manage draft policy recommendations.
- **[Profiles](/docs/sdks/go/0.1.7/api/profiles/)**: Manage provider type profiles (via `client.Providers().Profiles()`).
- **[Refresh](/docs/sdks/go/0.1.7/api/refresh/)**: Configure credential refresh strategies (via `client.Providers().Refresh()`).

## Common Patterns

SDK methods follow these conventions:

- Network operations take `context.Context`; list constructors return a pager,
  and each `NextPage` call accepts the request context
- Methods that can fail return `(result, error)`
- List methods accept variadic options and `ListAll` is the explicit exhaustive path
- Errors from the gateway carry a `StatusError` with a typed code (see [Error Handling](/docs/sdks/go/0.1.7/error-handling/))
