@freestyle-sh/with-opencode 0.0.4 → 0.0.6

package/README.md

@@ -92,17 +92,49 @@ new VmOpenCode({
     username: "admin", // Optional: Basic auth username (default: "opencode" when password is set)
     password: "secret", // Optional: Basic auth password
   },
+  env: {
+    ANTHROPIC_API_KEY: "sk-ant-...", // Optional: Environment variables for OpenCode
+  },
 });
 ```
 
-| Option            | Type     | Default      | Description                                      |
-| ----------------- | -------- | ------------ | ------------------------------------------------ |
-| `server.port`     | `number` | `4096`       | Port for the OpenCode API server                 |
-| `server.username` | `string` | `"opencode"` | Basic auth username (only used if password set)  |
-| `server.password` | `string` | -            | Basic auth password for the API server           |
-| `web.port`        | `number` | `4097`       | Port for the OpenCode web UI                     |
-| `web.username`    | `string` | `"opencode"` | Basic auth username (only used if password set)  |
-| `web.password`    | `string` | -            | Basic auth password for the web UI               |
+| Option            | Type                     | Default      | Description                                      |
+| ----------------- | ------------------------ | ------------ | ------------------------------------------------ |
+| `server.port`     | `number`                 | `4096`       | Port for the OpenCode API server                 |
+| `server.username` | `string`                 | `"opencode"` | Basic auth username (only used if password set)  |
+| `server.password` | `string`                 | -            | Basic auth password for the API server           |
+| `web.port`        | `number`                 | `4097`       | Port for the OpenCode web UI                     |
+| `web.username`    | `string`                 | `"opencode"` | Basic auth username (only used if password set)  |
+| `web.password`    | `string`                 | -            | Basic auth password for the web UI               |
+| `env`             | `Record<string, string>` | `{}`         | Environment variables passed to OpenCode processes |
+
+## Environment Variables
+
+OpenCode requires API keys to interact with AI providers. When running in a Freestyle VM, pass the required keys using the `env` option.
+
+> **Note:** Environment variables are stored as plain text in the VM's startup scripts. Users with direct or indirect access to the VM may be able to view these values. Use appropriately scoped API keys and rotate them if the VM is shared or exposed.
+
+| Variable              | Description                |
+| --------------------- | -------------------------- |
+| `ANTHROPIC_API_KEY`   | API key for Claude models  |
+| `OPENAI_API_KEY`      | API key for OpenAI models  |
+| `OPENROUTER_API_KEY`  | API key for OpenRouter     |
+
+See [OpenCode Providers](https://opencode.ai/docs/providers/) for all supported providers and their environment variables.
+
+```typescript
+const { vm } = await freestyle.vms.create({
+  spec: new VmSpec({
+    with: {
+      opencode: new VmOpenCode({
+        env: {
+          ANTHROPIC_API_KEY: process.env.ANTHROPIC_API_KEY!,
+        },
+      }),
+    },
+  }),
+});
+```
 
 ## API
 

package/dist/index.d.ts

@@ -1,6 +1,8 @@
 import * as freestyle_sandboxes from 'freestyle-sandboxes';
 import { VmWith, VmWithInstance, VmSpec } from 'freestyle-sandboxes';
 import * as _opencode_ai_sdk_v2 from '@opencode-ai/sdk/v2';
+import { Config } from '@opencode-ai/sdk/v2';
+export { Config as OpenCodeConfig } from '@opencode-ai/sdk/v2';
 
 type OpenCodeAuthOptions = {
     password?: string;
@@ -21,6 +23,7 @@ type OpenCodeOptions = {
         port?: number;
     } & OpenCodeAuthOptions;
     env?: Record<string, string>;
+    config?: Config;
 };
 type OpenCodeResolvedOptions = {
     server: {
@@ -30,6 +33,7 @@ type OpenCodeResolvedOptions = {
         port: number;
     } & ResolvedOpenCodeAuthOptions;
     env: Record<string, string>;
+    config?: Config;
 };
 declare class VmOpenCode extends VmWith<VmOpenCodeInstance> {
     options: OpenCodeResolvedOptions;

package/dist/index.js

@@ -17,7 +17,8 @@ class VmOpenCode extends VmWith {
         port: options?.web?.port ?? 4097,
         ...resolveAuth(options?.web)
       },
-      env: options?.env ?? {}
+      env: options?.env ?? {},
+      config: options?.config
     };
   }
   configureSnapshotSpec(spec) {
@@ -26,32 +27,42 @@ class VmOpenCode extends VmWith {
 export OPENCODE_SERVER_PASSWORD="${this.options.web.password}"` : "";
     const serverAuthEnv = this.options.server.username ? `export OPENCODE_SERVER_USERNAME="${this.options.server.username}"
 export OPENCODE_SERVER_PASSWORD="${this.options.server.password}"` : "";
-    return this.composeSpecs(
-      spec,
-      new VmSpec({
-        additionalFiles: {
-          "/opt/install-opencode.sh": {
-            content: `#!/bin/bash
+    const configPath = "/opt/opencode-config.json";
+    const configExport = this.options.config ? `export OPENCODE_CONFIG="${configPath}"` : "";
+    const additionalFiles = {
+      "/opt/install-opencode.sh": {
+        content: `#!/bin/bash
 curl -fsSL https://opencode.ai/install | bash
 `
-          },
-          "/opt/run-opencode-web.sh": {
-            content: `#!/bin/bash
+      },
+      "/opt/run-opencode-web.sh": {
+        content: `#!/bin/bash
 export PATH="$HOME/.local/bin:$PATH"
 ${webAuthEnv}
+${configExport}
 ${envExports}
 /root/.opencode/bin/opencode web --hostname 0.0.0.0 --port ${this.options.web.port}
 `
-          },
-          "/opt/run-opencode-server.sh": {
-            content: `#!/bin/bash
+      },
+      "/opt/run-opencode-server.sh": {
+        content: `#!/bin/bash
 export PATH="$HOME/.local/bin:$PATH"
 ${serverAuthEnv}
+${configExport}
 ${envExports}
 /root/.opencode/bin/opencode serve --hostname 0.0.0.0 --port ${this.options.server.port}
 `
-          }
-        },
+      }
+    };
+    if (this.options.config) {
+      additionalFiles[configPath] = {
+        content: JSON.stringify(this.options.config, null, 2)
+      };
+    }
+    return this.composeSpecs(
+      spec,
+      new VmSpec({
+        additionalFiles,
         systemd: {
           services: [
             {

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@freestyle-sh/with-opencode",
-  "version": "0.0.4",
-  "packageManager": "pnpm@10.11.0",
+  "version": "0.0.6",
   "private": false,
   "dependencies": {
     "@opencode-ai/sdk": "^1.1.42",
     "freestyle-sandboxes": "^0.1.13"
   },
   "devDependencies": {
-    "@freestyle-sh/with-web-terminal": "workspace:*",
+    "@types/node": "^25.1.0",
     "pkgroll": "^2.11.2",
-    "typescript": "^5.8.3"
+    "typescript": "^5.8.3",
+    "@freestyle-sh/with-web-terminal": "0.0.2"
   },
   "type": "module",
   "main": "./dist/index.js",
@@ -26,7 +26,6 @@
     "dist"
   ],
   "scripts": {
-    "build": "pkgroll",
-    "prepublishOnly": "pnpm run build"
+    "build": "pkgroll"
   }
-}
+}