@coder/ai-sdk-sandbox 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,328 @@
+# @coder/ai-sdk-sandbox
+
+A [Coder](https://coder.com) workspace sandbox provider for the Vercel AI SDK v7
+**HarnessAgent**. It lets you run CLI coding agents inside a real Coder workspace
+instead of an ephemeral cloud sandbox. Claude Code is verified end-to-end here;
+Codex is expected to work via the same bridge mechanism but is not yet verified
+in this repo.
+
+It implements the `HarnessV1SandboxProvider` contract from `@ai-sdk/harness`, so
+you pass it as the `sandbox` to a `HarnessAgent` exactly like
+`@ai-sdk/sandbox-vercel`.
+
+> **Status:** experimental. The AI SDK harness packages are published under the
+> `@canary` tag and their APIs can change between releases. This provider tracks
+> `@ai-sdk/harness@1.0.0-canary.11`.
+
+## Install
+
+```bash
+npm add @coder/ai-sdk-sandbox @ai-sdk/harness@canary @ai-sdk/harness-claude-code@canary @ai-sdk/provider-utils@canary
+```
+
+On the host you also need:
+
+- the [`coder` CLI](https://coder.com/docs/install) on PATH and authenticated
+  (`coder login`); for non-ambient auth, configure the transport explicitly with
+  `new CoderCliTransport({ url, token })` (see [Settings](#settings));
+- an **OpenSSH client** (`ssh`) on PATH — exec runs through it (see "How it works").
+
+## Quick start
+
+Wrap an existing, running workspace and run Claude Code in it:
+
+```ts
+import { HarnessAgent } from "@ai-sdk/harness/agent";
+import { createClaudeCode } from "@ai-sdk/harness-claude-code";
+import { createCoderWorkspace } from "@coder/ai-sdk-sandbox";
+
+const agent = new HarnessAgent({
+  harness: createClaudeCode({ thinking: "adaptive" }),
+  sandbox: createCoderWorkspace({ workspace: "my-dev-workspace" }),
+  instructions: "You are a careful coding assistant.",
+});
+
+const session = await agent.createSession();
+try {
+  const result = await agent.generate({
+    session,
+    prompt: "Create a short TODO.md in the repo root.",
+  });
+  console.log(result.text);
+} finally {
+  await session.destroy();
+}
+```
+
+See [`examples/claude-code.ts`](./examples/claude-code.ts) for a runnable version.
+
+## Creating workspaces on demand
+
+Instead of pointing at an existing workspace, you can have the provider **create
+one from a template** — with parameters and/or a preset — and tear it down when
+the session ends. Add a `create` block:
+
+```ts
+const agent = new HarnessAgent({
+  harness: createClaudeCode({ thinking: "adaptive" }),
+  sandbox: createCoderWorkspace({
+    create: {
+      template: "docker", // required: the template to create from
+      preset: "Large", // optional: a template version preset
+      parameters: { cpus: 8, region: "us-west-2" },
+      useParameterDefaults: true, // accept template defaults for the rest
+      stopAfter: "8h", // auto-stop TTL
+    },
+  }),
+});
+```
+
+By default this is **fresh-per-session**: the workspace name is derived from the
+harness `sessionId` (e.g. `agent-1a2b3c4d5e6f`), so each session gets its own
+workspace, and `session.destroy()` deletes it. `resumeSession` re-derives the
+same name and reattaches. The provider waits for the workspace agent to finish
+connecting and running its startup script (`lifecycle_state: ready`) before the
+harness runs — a successful _build_ is not enough on its own.
+
+You can also **get-or-create a named workspace** by combining `workspace` with
+`create`: if it exists the provider attaches to it (and never deletes it); if it
+doesn't, the provider creates it (and, by default, owns it).
+
+```ts
+createCoderWorkspace({
+  workspace: "my-agent-ws",
+  create: { template: "docker", ifExists: "attach" }, // 'attach' (default) | 'error'
+});
+```
+
+**Parameters vs. presets.** A preset's parameter values take precedence over an
+overlapping `parameters` entry of the same name (this is Coder's behavior), so
+set a given value via the preset _or_ `parameters`, not both. Required
+parameters (those without a template default) must be supplied via `parameters`,
+`parameterFile`, a `preset`, or `useParameterDefaults` — otherwise creation
+fails (it can't prompt non-interactively). If you set a `preset`, the provider
+preflight-validates the name against the template's presets and fails fast with
+the available names (set `validate: false` to skip).
+
+### Create settings
+
+```ts
+createCoderWorkspace({
+  create: {
+    template: "docker", // required
+    templateVersion: undefined, // default: the template's active version
+    preset: undefined, // 'none' forces no preset
+    parameters: {}, // { name: value }; numbers/bools stringified
+    parameterFile: undefined, // path to a YAML rich-parameter file
+    useParameterDefaults: false, // accept template defaults where unset
+    ephemeralParameters: {}, // one-time build parameters
+    stopAfter: undefined, // e.g. '8h' (auto-stop TTL)
+    automaticUpdates: undefined, // 'always' | 'never'
+    org: undefined, // --org, for ambiguous template names
+    owner: undefined, // owner for a derived name (owner/name)
+    ifExists: "attach", // 'attach' | 'error'
+    namePrefix: "agent", // prefix for the derived per-session name
+    validate: true, // preflight-check the preset name
+  },
+  readyTimeoutMs: 300_000, // wait budget for the agent to become ready
+});
+```
+
+## Terminal UI
+
+For an interactive chat in your terminal instead of one-shot `generate()` calls,
+wrap the same agent with the AI SDK terminal UI ([`@ai-sdk/tui`](https://ai-sdk.dev/v7/docs/ai-sdk-harnesses/terminal-ui)):
+
+```bash
+npm add @ai-sdk/tui@canary
+```
+
+The TUI drives a session-less agent, so adapt the `HarnessAgent` (whose
+`generate`/`stream` take a session) by injecting the session for the TUI's
+lifetime:
+
+```ts
+import { HarnessAgent, type HarnessAgentSession } from "@ai-sdk/harness/agent";
+import { createClaudeCode } from "@ai-sdk/harness-claude-code";
+import { runAgentTUI, type AgentTUIAgent } from "@ai-sdk/tui";
+import { createCoderWorkspace } from "@coder/ai-sdk-sandbox";
+
+const agent = new HarnessAgent({
+  harness: createClaudeCode({ thinking: "adaptive" }),
+  sandbox: createCoderWorkspace({ workspace: "my-dev-ws" }),
+  // or, to create a fresh workspace per session from a template:
+  // sandbox: createCoderWorkspace({ create: { template: 'claude-code-test' } }),
+});
+
+const toTUIAgent = (agent: HarnessAgent, session: HarnessAgentSession): AgentTUIAgent => ({
+  version: "agent-v1",
+  id: agent.id,
+  tools: agent.tools,
+  generate: (request) => agent.generate({ ...request, session }),
+  stream: (request) => agent.stream({ ...request, session }),
+});
+
+const session = await agent.createSession();
+try {
+  await runAgentTUI({ title: "Claude Code @ Coder", agent: toTUIAgent(agent, session) });
+} finally {
+  await session.destroy();
+}
+```
+
+See [`examples/claude-code-tui.ts`](./examples/claude-code-tui.ts) for a runnable
+version: `CODER_WORKSPACE=my-dev-ws npx tsx examples/claude-code-tui.ts` (exit with
+Esc or Ctrl+C).
+
+## Workspace requirements
+
+Because the bridge runs inside the workspace, the workspace image must have:
+
+- **Node.js** (the docs use `node24`). The bridge is `node bridge.mjs`.
+- **pnpm** available on PATH (e.g. via `corepack enable`) — the adapter uses it to
+  bootstrap the bridge.
+- **Outbound network access** to the npm registry (the adapter `pnpm install`s
+  the bridge's dependencies + the Claude Code CLI on first use) and to the model
+  API (`api.anthropic.com` for Claude Code, `api.openai.com` for Codex). Bake the
+  dependencies into the image to avoid per-session installs.
+- **The model API key** available to the bridge — `ANTHROPIC_API_KEY` /
+  `OPENAI_API_KEY`. Configure it through the adapter's `auth` option or ensure it
+  is present in the workspace environment.
+- `bash` and `base64` (standard on any Linux dev image).
+
+## Settings
+
+**At least one of `workspace` or `create` is required** (you may set both — see
+[Creating workspaces on demand](#creating-workspaces-on-demand)).
+
+```ts
+import { createCoderWorkspace, CoderCliTransport } from "@coder/ai-sdk-sandbox";
+
+createCoderWorkspace({
+  // One of these is required (TypeScript enforces it):
+  workspace: "my-ws", // fixed name, or (sessionId) => `agent-${sessionId}`
+  create: undefined, // create from a template; see "Creating workspaces"
+
+  readyTimeoutMs: 300_000, // wait budget for the agent to become ready
+  ports: [4000], // exposed ports; ports[0] is the bridge port
+  defaultWorkingDirectory: "/home/coder", // default: resolved from $HOME, else /home/coder
+  ownsLifecycle: false, // see "Lifecycle modes" below
+  ensureStarted: false, // run `coder start` before attaching
+
+  // Transport. Defaults to an ambient-login CoderCliTransport. Configure the CLI
+  // transport (binary paths, url/token, env, login shell, wait mode) — or supply
+  // a non-CLI/test transport — by constructing one explicitly:
+  transport: new CoderCliTransport({
+    // coderBinary: 'coder', sshBinary: 'ssh',
+    // url: process.env.CODER_URL, token: process.env.CODER_SESSION_TOKEN,
+    // env: {}, loginShell: true, waitMode: 'no',
+  }),
+});
+```
+
+### Lifecycle modes
+
+- **Wrap an existing workspace (default when there's no `create`,
+  `ownsLifecycle: false`).** `stop()` and `destroy()` only release host-side
+  resources (port-forwards); the workspace keeps running. The natural fit for
+  long-lived dev workspaces.
+- **Own the workspace (`ownsLifecycle: true`).** `stop()` runs `coder stop` and
+  `destroy()` runs `coder delete`.
+- **Create mode (`create` set).** `ownsLifecycle` defaults to `true`, so a
+  workspace the provider creates is deleted on `destroy()` and `onFirstCreate`
+  runs as its bootstrap hook. As a safety measure, a workspace the provider only
+  _attached_ to (an explicitly-named, pre-existing one) is **never** deleted —
+  only ones it actually created. A per-session derived name is always treated as
+  owned. Set `ownsLifecycle: false` for "create-if-missing but never delete".
+
+### Ports
+
+The adapter binds its bridge to a port and resolves it from
+`createClaudeCode({ port })` or, by default, `sandbox.ports[0]`. Expose that port
+via `ports` (default `[4000]`); `getPortUrl` opens an OpenSSH `-L` local forward
+(over the same `coder ssh --stdio` ProxyCommand) to it on demand and returns a
+loopback `ws://` URL. The forward is plaintext on loopback, so `https`/`wss`
+requests resolve to their `http`/`ws` loopback equivalent.
+
+## How it works
+
+A `HarnessAgent` doesn't run the agent CLI directly. For bridge-backed adapters
+(Claude Code, Codex) it installs a small Node "bridge" program **inside the
+sandbox**, spawns it, and talks to it over an **authenticated WebSocket**. The
+bridge runs the vendor SDK in-workspace and streams events back to the host.
+
+This provider maps that contract onto Coder primitives:
+
+| Harness contract                            | Coder implementation                                                                        |
+| ------------------------------------------- | ------------------------------------------------------------------------------------------- |
+| `run` / `spawn`                             | OpenSSH `bash -lc '…'` over a `coder ssh --stdio` ProxyCommand                              |
+| `readFile` / `writeFile` / `read*`/`write*` | base64 piped over the SSH connection (binary-safe)                                          |
+| `getPortUrl({ port, protocol })`            | OpenSSH `-L <local>:127.0.0.1:<port>` over the same ProxyCommand → `ws://127.0.0.1:<local>` |
+| `ports` / `setPorts`                        | the workspace's exposed port set                                                            |
+| `createSession` / `resumeSession` / `id`    | attach to a workspace by name                                                               |
+| `stop` / `destroy`                          | `coder stop` / `coder delete` (only when it owns the lifecycle)                             |
+
+**Why OpenSSH and not `coder ssh <ws> -- cmd`?** `coder ssh` allocates a PTY for
+the command, which rewrites newlines to CRLF, merges stdout and stderr onto one
+stream, and does not reliably propagate exit codes — all fatal for programmatic
+use and for the bridge's stdout parsing. `coder ssh`'s own help recommends
+`coder config-ssh` "for users who need the full functionality of SSH"; this
+provider does the programmatic equivalent, running real OpenSSH over a
+`coder ssh --stdio` ProxyCommand. That yields clean, separated streams and
+correct exit codes (verified against a live workspace).
+
+The WebSocket the harness opens against `getPortUrl(...)` is the critical path,
+and it needs no wildcard access URLs — the host running `HarnessAgent` is already
+a Coder client. We forward via OpenSSH `-L` rather than `coder port-forward`:
+the bridge sends an _unprompted_ `bridge-hello` frame immediately after the WS
+upgrade, and in testing a freshly-created `coder port-forward` tunnel did not
+reliably deliver that first server-initiated frame to the first WS client,
+whereas SSH local forwarding does. This path is verified end-to-end against a
+real workspace — both a synthetic WebSocket round-trip (`scripts/verify-real.ts`)
+and a full Claude Code turn with tool use (`scripts/e2e-claude.ts`).
+
+## Limitations & notes
+
+- `setNetworkPolicy` is not implemented (omitted) — egress is governed by your
+  Coder template/deployment, not this provider.
+- `bridgePorts` is intentionally left undefined: this provider binds one
+  workspace per session rather than leasing ports from a shared sandbox.
+- File reads buffer the whole file (binary content moves as base64). Fine for
+  bootstrap-sized files; not intended for streaming very large files.
+- `@ai-sdk/sandbox-just-bash` cannot expose ports and is rejected by bridge-backed
+  adapters — this provider exists precisely to provide that port.
+- To run Claude Code / Codex, the **workspace** image needs Node.js (the adapter
+  installs the bridge + CLI on first use) and egress to the npm registry and the
+  model API. Provide the API key via the adapter's `auth` option.
+
+## Development
+
+```bash
+npm install
+npm run typecheck   # tsc against the real canary harness types
+npm test            # vitest: unit + local integration (fake `coder` + `ssh`)
+npm run build       # tsup → dist/ (ESM + d.ts)
+
+# Formatting & linting (Biome):
+npm run format      # biome format --write .   (apply formatting)
+npm run lint        # biome lint .             (report lint issues)
+npm run check       # biome check .            (format + lint, read-only; for CI)
+
+# End-to-end against a real workspace (needs the coder CLI + a running workspace):
+npm run verify:real -- my-ws
+
+# End-to-end of create mode (creates a throwaway workspace, then deletes it):
+npm run verify:create -- docker
+```
+
+The local integration tests exercise the real transport (argument building,
+stdin, base64 file round-trips, streaming, the port-forward lifecycle, and the
+create/status/presets JSON paths) against fake `coder`/`ssh` executables that run
+commands locally — no Coder deployment needed. `scripts/verify-real.ts` runs the
+same surface — plus a real WebSocket-over-SSH round-trip — against an actual
+workspace; `scripts/verify-create.ts` creates a throwaway workspace from a
+template, waits for readiness, runs a command in it, and deletes it.
+
+## License
+
+Apache-2.0