@freestyle-sh/with-opencode 0.0.1

package/README.md

@@ -0,0 +1,127 @@
+# @freestyle-sh/with-opencode
+
+[OpenCode](https://opencode.ai) integration for [Freestyle](https://freestyle.sh) VMs. Provides a fully configured OpenCode AI coding assistant server in your Freestyle VM.
+
+## Installation
+
+```bash
+bun add @freestyle-sh/with-opencode freestyle-sandboxes
+```
+
+## Usage
+
+### Basic Setup
+
+```typescript
+import { freestyle, VmSpec } from "freestyle-sandboxes";
+import { VmOpenCode } from "@freestyle-sh/with-opencode";
+
+const { vm } = await freestyle.vms.create({
+  spec: new VmSpec({
+    with: {
+      opencode: new VmOpenCode(),
+    },
+  }),
+});
+
+// Expose the web UI
+const { url } = await vm.opencode.routeWeb();
+console.log(`OpenCode UI: ${url}`);
+```
+
+### Using the API Client
+
+```typescript
+const { client } = await vm.opencode.client();
+
+// Use the OpenCode SDK client to interact with the server
+const sessions = await client.session.list();
+```
+
+### With Custom Domain
+
+```typescript
+const { url } = await vm.opencode.routeWeb({
+  domain: "my-opencode.example.com",
+});
+
+const { client } = await vm.opencode.client({
+  domain: "my-opencode-api.example.com",
+});
+```
+
+## Options
+
+```typescript
+new VmOpenCode({
+  serverPort: 4096, // Optional: API server port (default: 4096)
+  webPort: 4097,    // Optional: Web UI port (default: 4097)
+})
+```
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `serverPort` | `number` | `4096` | Port for the OpenCode API server |
+| `webPort` | `number` | `4097` | Port for the OpenCode web UI |
+
+## API
+
+### `vm.opencode.routeWeb(options?)`
+
+Exposes the OpenCode web UI on a public domain.
+
+**Options:**
+- `domain?: string` - Custom domain to use. If not specified, generates a random subdomain.
+
+**Returns:** `Promise<{ url: string }>`
+
+```typescript
+const { url } = await vm.opencode.routeWeb();
+console.log(`OpenCode UI available at: ${url}`);
+```
+
+### `vm.opencode.client(options?)`
+
+Creates an OpenCode SDK client connected to the server.
+
+**Options:**
+- `domain?: string` - Custom domain for the API endpoint. If not specified, generates a random subdomain.
+
+**Returns:** `Promise<{ client: OpencodeClient }>`
+
+```typescript
+const { client } = await vm.opencode.client();
+
+// List sessions
+const sessions = await client.session.list();
+
+// Create a new session
+const session = await client.session.create({ path: "/workspace" });
+```
+
+### `vm.opencode.serverPort()`
+
+Returns the configured API server port.
+
+**Returns:** `number`
+
+### `vm.opencode.webPort()`
+
+Returns the configured web UI port.
+
+**Returns:** `number`
+
+## How It Works
+
+The package uses systemd services to install and run OpenCode during VM creation:
+
+1. Installs OpenCode via the official install script
+2. Starts the OpenCode API server (`opencode serve`)
+3. Starts the OpenCode web UI (`opencode web`)
+
+Both services are configured to restart automatically and listen on all interfaces (0.0.0.0).
+
+## Documentation
+
+- [Freestyle Documentation](https://docs.freestyle.sh)
+- [OpenCode Documentation](https://opencode.ai/docs)

package/dist/index.d.ts

@@ -0,0 +1,40 @@
+import * as freestyle_sandboxes from 'freestyle-sandboxes';
+import { VmWith, VmWithInstance, VmSpec } from 'freestyle-sandboxes';
+import * as _opencode_ai_sdk from '@opencode-ai/sdk';
+
+type OpenCodeOptions = {
+    serverPort?: number;
+    webPort?: number;
+};
+type OpenCodeResolvedOptions = {
+    serverPort: number;
+    webPort: number;
+};
+declare class VmOpenCode extends VmWith<VmOpenCodeInstance> {
+    options: OpenCodeResolvedOptions;
+    constructor(options?: OpenCodeOptions);
+    configureSnapshotSpec(spec: VmSpec): VmSpec;
+    createInstance(): VmOpenCodeInstance;
+    installServiceName(): string;
+}
+declare class VmOpenCodeInstance extends VmWithInstance {
+    builder: VmOpenCode;
+    constructor(builder: VmOpenCode);
+    webPort(): number;
+    serverPort(): number;
+    client({ domain }?: {
+        domain?: string;
+    }): Promise<{
+        client: _opencode_ai_sdk.OpencodeClient;
+    }>;
+    routeWeb({ domain }?: {
+        domain?: string;
+    }): Promise<{
+        url: string;
+    }>;
+    /** @internal */
+    get _vm(): freestyle_sandboxes.Vm;
+}
+
+export { VmOpenCode };
+export type { OpenCodeOptions, OpenCodeResolvedOptions };

package/dist/index.js

@@ -0,0 +1,135 @@
+import { VmWith, VmSpec, VmWithInstance } from 'freestyle-sandboxes';
+import { createOpencodeClient } from '@opencode-ai/sdk';
+
+class VmOpenCode extends VmWith {
+  options;
+  constructor(options) {
+    super();
+    this.options = {
+      serverPort: options?.serverPort ?? 4096,
+      webPort: options?.webPort ?? 4097
+    };
+  }
+  configureSnapshotSpec(spec) {
+    return this.composeSpecs(
+      spec,
+      new VmSpec({
+        additionalFiles: {
+          "/opt/install-opencode.sh": {
+            content: `
+            #!/bin/bash
+
+            curl -fsSL https://opencode.ai/install | bash
+            `
+          },
+          "/opt/run-opencode-web.sh": {
+            content: `
+              #!/bin/bash
+
+              export PATH="$HOME/.local/bin:$PATH"
+              /root/.opencode/bin/opencode web --hostname 0.0.0.0 --port ${this.options.webPort}
+              `
+          },
+          "/opt/run-opencode-server.sh": {
+            content: `
+              #!/bin/bash
+
+              export PATH="$HOME/.local/bin:$PATH"
+              /root/.opencode/bin/opencode serve --hostname 0.0.0.0 --port ${this.options.serverPort}
+              `
+          }
+        },
+        systemd: {
+          services: [
+            {
+              name: "install-opencode",
+              mode: "oneshot",
+              env: {
+                HOME: "/root"
+              },
+              exec: ["bash /opt/install-opencode.sh"],
+              timeoutSec: 300
+            },
+            {
+              name: "opencode-server",
+              mode: "service",
+              env: {
+                HOME: "/root"
+              },
+              after: ["install-opencode.service"],
+              requires: ["install-opencode.service"],
+              restartPolicy: {
+                policy: "always"
+              },
+              exec: ["bash /opt/run-opencode-server.sh"]
+            },
+            {
+              name: "opencode-web",
+              mode: "service",
+              env: {
+                HOME: "/root"
+              },
+              after: ["install-opencode.service"],
+              requires: ["install-opencode.service"],
+              restartPolicy: {
+                policy: "always"
+              },
+              exec: ["bash /opt/run-opencode-web.sh"]
+            }
+          ]
+        }
+      })
+    );
+  }
+  createInstance() {
+    return new VmOpenCodeInstance(this);
+  }
+  installServiceName() {
+    return "install-opencode.service";
+  }
+}
+class VmOpenCodeInstance extends VmWithInstance {
+  builder;
+  constructor(builder) {
+    super();
+    this.builder = builder;
+  }
+  webPort() {
+    return this.builder.options.webPort;
+  }
+  serverPort() {
+    return this.builder.options.serverPort;
+  }
+  async client({ domain } = {}) {
+    const resolvedDomain = domain ?? `${crypto.randomUUID()}-opencode.style.dev`;
+    const freestyle = this._vm._freestyle;
+    await freestyle.domains.mappings.create({
+      domain: resolvedDomain,
+      vmId: this.vm.vmId,
+      vmPort: this.serverPort()
+    });
+    return {
+      client: createOpencodeClient({
+        baseUrl: `https://${resolvedDomain}`
+      })
+    };
+  }
+  async routeWeb({ domain } = {}) {
+    const resolvedDomain = domain ?? `${crypto.randomUUID()}-opencode.style.dev`;
+    const freestyle = this._vm._freestyle;
+    await freestyle.domains.mappings.create({
+      domain: resolvedDomain,
+      vmId: this.vm.vmId,
+      vmPort: this.webPort()
+    });
+    return {
+      url: `https://${resolvedDomain}`
+    };
+  }
+  /** @internal */
+  get _vm() {
+    return this.vm;
+  }
+}
+
+export { VmOpenCode };

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@freestyle-sh/with-opencode",
+  "version": "0.0.1",
+  "packageManager": "pnpm@10.11.0",
+  "private": false,
+  "dependencies": {
+    "@opencode-ai/sdk": "^1.1.42",
+    "freestyle-sandboxes": "^0.1.13"
+  },
+  "devDependencies": {
+    "@freestyle-sh/with-web-terminal": "workspace:*",
+    "pkgroll": "^2.11.2",
+    "typescript": "^5.8.3"
+  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "source": "./src/index.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "pkgroll",
+    "prepublishOnly": "pnpm run build"
+  }
+}