> ## Documentation Index
> Fetch the complete documentation index at: https://opensandbox-oc-s-762ac928075c46d2828bcb22.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# TypeScript SDK

> Complete TypeScript SDK reference

## Installation

<CodeGroup>
  ```bash npm theme={null}
  npm install @opencomputer/sdk
  ```

  ```bash yarn theme={null}
  yarn add @opencomputer/sdk
  ```

  ```bash pnpm theme={null}
  pnpm add @opencomputer/sdk
  ```
</CodeGroup>

```typescript theme={null}
import { Sandbox } from "@opencomputer/sdk";
import { Image, Snapshots } from "@opencomputer/sdk/node";
```

> Note: The SDK is ESM-only. Use Node 18+ with `"type": "module"` (or `.mjs/.mts`) and top-level `await`, or use `const { Sandbox } = await import("@opencomputer/sdk"); const { Image, Snapshots } = await import("@opencomputer/sdk/node");` in CommonJS.

## Modules

<CardGroup cols={2}>
  <Card title="Sandbox" icon="box" href="/reference/typescript-sdk/sandbox">
    Create, connect, and manage sandbox lifecycle
  </Card>

  <Card title="Usage & Tags" icon="gauge" href="/reference/typescript-sdk/usage">
    Query usage, group by tag, and manage sandbox tags
  </Card>

  <Card title="Exec" icon="terminal" href="/reference/typescript-sdk/exec">
    Run commands and manage exec sessions
  </Card>

  <Card title="Agent" icon="robot" href="/reference/typescript-sdk/agent">
    Start and manage Claude agent sessions
  </Card>

  <Card title="Filesystem" icon="folder" href="/reference/typescript-sdk/filesystem">
    Read, write, and manage files
  </Card>

  <Card title="PTY" icon="rectangle-terminal" href="/reference/typescript-sdk/pty">
    Interactive terminal sessions
  </Card>

  <Card title="Image" icon="layer-group" href="/reference/typescript-sdk/image">
    Declarative sandbox image builder
  </Card>

  <Card title="Snapshots" icon="camera" href="/reference/typescript-sdk/snapshots">
    Pre-built sandbox environments
  </Card>

  <Card title="Secret Stores" icon="key" href="/reference/typescript-sdk/secrets">
    Manage secrets and egress control
  </Card>
</CardGroup>