{"id":36954196,"url":"https://github.com/ben-vargas/ai-sdk-provider-opencode-sdk","last_synced_at":"2026-04-02T21:56:57.033Z","repository":{"id":328064583,"uuid":"1113559014","full_name":"ben-vargas/ai-sdk-provider-opencode-sdk","owner":"ben-vargas","description":"Vercel AI SDK community provider for OpenCode SDK - Use OpenCode configured providers via SDK","archived":false,"fork":false,"pushed_at":"2026-01-02T01:07:31.000Z","size":257,"stargazers_count":9,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-07T10:47:01.784Z","etag":null,"topics":["ai-sdk","ai-sdk-v5","anthropic","gemini","openai","opencode","opencode-ai","sst","zen"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ben-vargas.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-12-10T06:27:02.000Z","updated_at":"2026-01-07T03:19:05.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/ben-vargas/ai-sdk-provider-opencode-sdk","commit_stats":null,"previous_names":["ben-vargas/ai-sdk-provider-opencode-sdk"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/ben-vargas/ai-sdk-provider-opencode-sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ben-vargas%2Fai-sdk-provider-opencode-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ben-vargas%2Fai-sdk-provider-opencode-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ben-vargas%2Fai-sdk-provider-opencode-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ben-vargas%2Fai-sdk-provider-opencode-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ben-vargas","download_url":"https://codeload.github.com/ben-vargas/ai-sdk-provider-opencode-sdk/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ben-vargas%2Fai-sdk-provider-opencode-sdk/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28385798,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-13T12:01:30.995Z","status":"ssl_error","status_checked_at":"2026-01-13T12:00:09.625Z","response_time":56,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai-sdk","ai-sdk-v5","anthropic","gemini","openai","opencode","opencode-ai","sst","zen"],"created_at":"2026-01-13T12:59:15.276Z","updated_at":"2026-04-02T21:56:57.026Z","avatar_url":"https://github.com/ben-vargas.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://img.shields.io/badge/status-beta-orange\" alt=\"beta status\"\u003e\n  \u003ca href=\"https://www.npmjs.com/package/ai-sdk-provider-opencode-sdk\"\u003e\u003cimg src=\"https://img.shields.io/npm/v/ai-sdk-provider-opencode-sdk?color=00A79E\" alt=\"npm version\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/ai-sdk-provider-opencode-sdk\"\u003e\u003cimg src=\"https://img.shields.io/npm/unpacked-size/ai-sdk-provider-opencode-sdk?color=00A79E\" alt=\"install size\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/ai-sdk-provider-opencode-sdk\"\u003e\u003cimg src=\"https://img.shields.io/npm/dy/ai-sdk-provider-opencode-sdk.svg?color=00A79E\" alt=\"npm downloads\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://nodejs.org/en/about/releases/\"\u003e\u003cimg src=\"https://img.shields.io/badge/node-%3E%3D18-00A79E\" alt=\"Node.js ≥ 18\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/ai-sdk-provider-opencode-sdk\"\u003e\u003cimg src=\"https://img.shields.io/npm/l/ai-sdk-provider-opencode-sdk?color=00A79E\" alt=\"License: MIT\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n# AI SDK Provider for OpenCode\n\n\u003e **Latest Release**: Version 3.x supports AI SDK v6. Version 2.x is the previous AI SDK v6 line. For AI SDK v5 support, use the `ai-sdk-v5` tag (0.x.x).\n\nA community provider for the [Vercel AI SDK](https://sdk.vercel.ai/docs) that enables using AI models through [OpenCode](https://opencode.ai) and the `@opencode-ai/sdk/v2` APIs. OpenCode is a terminal-based AI coding assistant that supports multiple providers (Anthropic, OpenAI, Google, and more).\n\nThis provider enables you to use OpenCode's AI capabilities through the familiar Vercel AI SDK interface, supporting `generateText()`, `streamText()`, `streamObject()`, native JSON-schema structured output with practical fallback patterns, tool approval flows, and file/source streaming parts.\n\n## Version Compatibility\n\n| Provider Version | AI SDK Version | NPM Tag     | Status      | Branch                                                                                   |\n| ---------------- | -------------- | ----------- | ----------- | ---------------------------------------------------------------------------------------- |\n| 3.x.x            | v6             | `latest`    | Stable      | `main`                                                                                   |\n| 2.x.x            | v6             | N/A         | Legacy      | historical                                                                               |\n| 1.x.x            | v6             | N/A         | Legacy      | historical                                                                               |\n| 0.x.x            | v5             | `ai-sdk-v5` | Maintenance | [`ai-sdk-v5`](https://github.com/ben-vargas/ai-sdk-provider-opencode-sdk/tree/ai-sdk-v5) |\n\n## Breaking Changes in 2.0.0\n\nThis release upgrades the provider internals to OpenCode SDK v2 and includes behavior changes that can affect existing integrations:\n\n- OpenCode request/response routing now uses v2 parameter shapes (`sessionID`, top-level args).\n- New settings are available: `permission`, `variant`, `directory`, `outputFormatRetryCount`.\n- `cwd` and `tools` remain supported but are now legacy/deprecated pathways.\n- Structured output uses OpenCode native `json_schema` mode. Depending on model/backend route, strict object generation can still be inconsistent.\n\nFor production object extraction, use a two-step pattern: try `Output.object(...)` first, then fallback to strict JSON prompting + parse/validate.\n\n### Installing the Right Version\n\n**For AI SDK v6 (recommended):**\n\n```bash\nnpm install ai-sdk-provider-opencode-sdk ai@^6.0.0\n```\n\n**For AI SDK v5:**\n\n```bash\nnpm install ai-sdk-provider-opencode-sdk@ai-sdk-v5 ai@^5.0.0\n```\n\n## Zod Compatibility\n\nThis package is compatible with **Zod 3 and Zod 4** (aligned with `ai`):\n\n```bash\n# With Zod 3\nnpm install ai-sdk-provider-opencode-sdk ai zod@^3.25.76\n\n# With Zod 4\nnpm install ai-sdk-provider-opencode-sdk ai zod@^4.1.8\n```\n\n## Prerequisites\n\n- Node.js \u003e= 18\n- [OpenCode CLI](https://opencode.ai) installed (`npm install -g opencode`)\n- Valid API keys configured in OpenCode for your preferred providers\n\n## Quick Start\n\n```typescript\nimport { generateText } from \"ai\";\nimport { opencode } from \"ai-sdk-provider-opencode-sdk\";\n\nconst result = await generateText({\n  model: opencode(\"openai/gpt-5.3-codex-spark\"),\n  prompt: \"What is the capital of France?\",\n});\n\nconsole.log(result.text);\n```\n\n## Usage\n\n### Creating a Provider\n\n```typescript\nimport { createOpencode } from \"ai-sdk-provider-opencode-sdk\";\n\n// Default provider (auto-starts server)\nconst opencode = createOpencode();\n\n// With custom settings\nconst opencode = createOpencode({\n  hostname: \"127.0.0.1\",\n  port: 4096,\n  autoStartServer: true,\n  serverTimeout: 10000,\n  defaultSettings: {\n    agent: \"build\",\n    sessionTitle: \"My Session\",\n  },\n});\n```\n\n### Model Selection\n\nModels are specified in `providerID/modelID` format:\n\n```typescript\n// Anthropic models (Claude 4.5 series)\nopencode(\"anthropic/claude-sonnet-4-5-20250929\");\nopencode(\"anthropic/claude-haiku-4-5-20251001\");\nopencode(\"anthropic/claude-opus-4-5-20251101\");\n\n// OpenAI models (GPT-5.3 / GPT-5.1 series)\nopencode(\"openai/gpt-5.3-codex-spark\");\nopencode(\"openai/gpt-5.1\");\nopencode(\"openai/gpt-5.1-codex\");\n\n// Google Gemini models\nopencode(\"google/gemini-3-pro-preview\");\nopencode(\"google/gemini-2.5-flash\");\nopencode(\"google/gemini-2.5-pro\");\nopencode(\"google/gemini-2.0-flash\");\n```\n\n### Streaming\n\n```typescript\nimport { streamText } from \"ai\";\n\nconst result = streamText({\n  model: opencode(\"openai/gpt-5.3-codex-spark\"),\n  prompt: \"Write a haiku about coding.\",\n});\n\nfor await (const chunk of result.textStream) {\n  process.stdout.write(chunk);\n}\n```\n\n### Conversation History\n\n```typescript\nimport { generateText, type ModelMessage } from \"ai\";\n\nconst messages: ModelMessage[] = [\n  { role: \"user\", content: \"My name is Alice.\" },\n  { role: \"assistant\", content: \"Hello Alice! How can I help you today?\" },\n  { role: \"user\", content: \"What is my name?\" },\n];\n\nconst result = await generateText({\n  model: opencode(\"openai/gpt-5.3-codex-spark\"),\n  messages,\n});\n```\n\n### Agent Selection\n\nOpenCode supports different agents for different tasks:\n\n```typescript\nconst model = opencode(\"openai/gpt-5.3-codex-spark\", {\n  agent: \"build\", // or 'plan', 'general', 'explore'\n});\n```\n\n### Session Management\n\nSessions maintain conversation context:\n\n```typescript\nconst model = opencode(\"openai/gpt-5.3-codex-spark\", {\n  sessionTitle: \"Code Review Session\",\n});\n\n// First call creates a session\nconst result1 = await generateText({ model, prompt: \"Review this code...\" });\n\n// Subsequent calls reuse the same session\nconst result2 = await generateText({ model, prompt: \"What did you find?\" });\n\n// Get session ID from metadata\nconst sessionId = result1.providerMetadata?.opencode?.sessionId;\n\n// Resume a specific session\nconst resumeModel = opencode(\"openai/gpt-5.3-codex-spark\", {\n  sessionId: sessionId,\n});\n```\n\n### Tool Observation\n\nOpenCode executes tools server-side. You can observe tool execution but cannot provide custom implementations:\n\n```typescript\nimport { streamText } from \"ai\";\n\nconst result = streamText({\n  model: opencode(\"openai/gpt-5.3-codex-spark\"),\n  prompt: \"List files in the current directory.\",\n});\n\nfor await (const part of result.fullStream) {\n  switch (part.type) {\n    case \"tool-call\":\n      console.log(`tool-call: ${part.toolName}`);\n      break;\n    case \"tool-result\":\n      console.log(`tool-result: ${part.toolName}`);\n      break;\n    case \"tool-approval-request\":\n      console.log(`approval-request: ${part.approvalId}`);\n      break;\n    case \"file\":\n      console.log(`file: ${part.file.mediaType}`);\n      break;\n    case \"source\":\n      console.log(`source: ${part.sourceType}`);\n      break;\n    case \"text-delta\":\n      process.stdout.write(part.text ?? \"\");\n      break;\n    case \"finish\":\n      console.log(`finish: ${part.finishReason}`);\n      break;\n    case \"error\":\n      console.error(part.error);\n      break;\n  }\n}\n```\n\n## Feature Support\n\n| Feature                  | Support    | Notes                                                                       |\n| ------------------------ | ---------- | --------------------------------------------------------------------------- |\n| Text generation          | ✅ Full    | `generateText()`, `streamText()`                                            |\n| Streaming                | ✅ Full    | Real-time SSE streaming                                                     |\n| Multi-turn conversations | ✅ Full    | Session-based context                                                       |\n| Tool observation         | ✅ Full    | See tool execution                                                          |\n| Reasoning/thinking       | ✅ Full    | ReasoningPart support                                                       |\n| Model selection          | ✅ Full    | Per-request model                                                           |\n| Agent selection          | ✅ Full    | build, plan, general, explore                                               |\n| Abort/cancellation       | ✅ Full    | AbortSignal support                                                         |\n| Image input (base64)     | ⚠️ Partial | Data URLs only                                                              |\n| Image input (URL)        | ❌ None    | Not supported                                                               |\n| Structured output (JSON) | ⚠️ Partial | Native `json_schema`; use prompt+validation fallback for strict reliability |\n| Custom tools             | ❌ None    | Server-side only                                                            |\n| Tool approvals           | ✅ Full    | `tool-approval-request` / `tool-approval-response`                          |\n| File/source streaming    | ✅ Full    | Emits `file` and `source` stream parts                                      |\n| temperature/topP/topK    | ❌ None    | Provider defaults                                                           |\n| maxTokens                | ❌ None    | Agent config                                                                |\n\n## Examples\n\n- `examples/basic-usage.ts` - Minimal text generation.\n- `examples/streaming.ts` - Streaming text chunks and final usage.\n- `examples/conversation-history.ts` - Multi-turn prompts with session continuity.\n- `examples/generate-object.ts` - Native object mode with robust JSON fallback.\n- `examples/stream-object.ts` - Streaming structured output with fallback parsing.\n- `examples/tool-observation.ts` - Observe tool calls, results, approvals, files, and sources.\n- `examples/abort-signal.ts` - Cancellation patterns for generate and stream calls.\n- `examples/image-input.ts` - File/image input using base64 or data URLs.\n- `examples/custom-config.ts` - Provider/model configuration and reliability controls.\n- `examples/client-options.ts` - `clientOptions` passthrough and preconfigured `client` patterns.\n- `examples/limitations.ts` - Practical limitations and expected behaviors.\n- `examples/long-running-tasks.ts` - Patterns for longer tasks and retries.\n\n## Provider Settings\n\n```typescript\ninterface OpencodeProviderSettings {\n  hostname?: string; // Default: '127.0.0.1'\n  port?: number; // Default: 4096\n  baseUrl?: string; // Override full URL\n  autoStartServer?: boolean; // Default: true\n  serverTimeout?: number; // Default: 10000\n  clientOptions?: OpencodeClientOptions; // Pass-through to createOpencodeClient()\n  client?: OpencodeClient; // Preconfigured SDK client (bypasses server management)\n  defaultSettings?: OpencodeSettings;\n}\n```\n\n`clientOptions` forwards OpenCode SDK client configuration such as:\n\n- `headers` (custom HTTP headers)\n- `fetch` (custom fetch implementation)\n- `auth` (token or auth function)\n- `bodySerializer` / `querySerializer`\n- `requestValidator` / `responseValidator` / `responseTransformer`\n- `throwOnError`\n- standard `RequestInit` fields (`credentials`, `mode`, `cache`, `signal`, etc.)\n\nNotes:\n\n- `baseUrl` and `directory` remain provider/model managed (`baseUrl` at provider level, `directory` via `defaultSettings` or per-model settings).\n- If both `client` and `clientOptions` are provided, `client` takes precedence.\n- If `client` is provided, its lifecycle remains caller-managed; `dispose()` only cleans up provider-managed server processes.\n\nExample:\n\n```typescript\nconst opencode = createOpencode({\n  baseUrl: \"http://127.0.0.1:4096\",\n  clientOptions: {\n    headers: {\n      \"x-api-key\": process.env.OPENCODE_API_KEY ?? \"\",\n    },\n    credentials: \"include\",\n    throwOnError: true,\n  },\n});\n```\n\n## Model Settings\n\n```typescript\ninterface OpencodeSettings {\n  sessionId?: string; // Resume session\n  createNewSession?: boolean; // Force new session\n  sessionTitle?: string; // Title for new sessions\n  agent?: string; // Agent name\n  systemPrompt?: string; // Override system prompt\n  tools?: Record\u003cstring, boolean\u003e; // Enable/disable tools (deprecated in favor of permissions)\n  permission?: Array\u003c{\n    permission: string;\n    pattern: string;\n    action: \"allow\" | \"deny\" | \"ask\";\n  }\u003e; // Session ruleset\n  variant?: string; // OpenCode variant\n  directory?: string; // Per-request directory\n  cwd?: string; // Legacy working directory alias\n  outputFormatRetryCount?: number; // JSON schema retry count\n  logger?: Logger | false; // Logging\n  verbose?: boolean; // Debug logging\n}\n```\n\n## Advanced Exports\n\nThe package also exports lower-level APIs for advanced integrations:\n\n- Runtime classes: `OpencodeLanguageModel`, `OpencodeClientManager`\n- Validation/config helpers: `validateSettings`, `validateProviderSettings`, `validateModelId`, `mergeSettings`\n- Logging helpers: `getLogger`, `defaultLogger`, `silentLogger`, `createContextLogger`\n- Event/message utilities: `convertToOpencodeMessages`, `convertEventToStreamParts`, `createStreamState`, `createFinishParts`\n\nThese are intended for power users and tooling integrations. Most applications should use `createOpencode()` / `opencode()` directly.\n\n## Error Handling\n\nThe provider converts OpenCode errors to AI SDK error types:\n\n```typescript\nimport {\n  isAuthenticationError,\n  isTimeoutError,\n} from \"ai-sdk-provider-opencode-sdk\";\n\ntry {\n  const result = await generateText({ model, prompt: \"...\" });\n} catch (error) {\n  if (isAuthenticationError(error)) {\n    console.error(\"Check your API keys in OpenCode\");\n  } else if (isTimeoutError(error)) {\n    console.error(\"Request timed out\");\n  }\n}\n```\n\n## Structured Output Reliability\n\nWhen using `Output.object(...)`, the provider sends OpenCode native `format: { type: \"json_schema\", schema }`. This is the preferred path and works in many cases.\n\nSome model/backend routes can still return output that does not parse into a strict object every time. The examples `examples/generate-object.ts` and `examples/stream-object.ts` intentionally demonstrate a robust fallback strategy:\n\n1. Try native structured output.\n2. Retry a small number of times.\n3. Fallback to strict JSON prompting and validate with Zod.\n\n## Cleanup\n\nAlways dispose of the provider when done to stop the managed server:\n\n```typescript\nconst opencode = createOpencode();\n\n// ... use the provider ...\n\n// Clean up\nawait opencode.dispose?.();\n```\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fben-vargas%2Fai-sdk-provider-opencode-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fben-vargas%2Fai-sdk-provider-opencode-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fben-vargas%2Fai-sdk-provider-opencode-sdk/lists"}