OpenCode Provider
The ai-sdk-provider-opencode-sdk community provider enables using multiple AI providers (Anthropic, OpenAI, Google) through the OpenCode SDK. OpenCode is a terminal-based AI coding assistant that provides a unified interface to various AI models.
Version Compatibility
| Provider Version | AI SDK Version | NPM Tag | Status |
|---|---|---|---|
| 1.x | v6 | latest | Stable |
| 0.x | v5 | ai-sdk-v5 | Maintenance |
# AI SDK v6 (default)npm install ai-sdk-provider-opencode-sdk ai
# AI SDK v5npm install ai-sdk-provider-opencode-sdk@ai-sdk-v5 ai@^5.0.0Setup
pnpm add ai-sdk-provider-opencode-sdk
Provider Instance
You can import the default provider instance opencode from ai-sdk-provider-opencode-sdk:
import { opencode } from 'ai-sdk-provider-opencode-sdk';If you need a customized setup, you can import createOpencode and create a provider instance with your settings:
import { createOpencode } from 'ai-sdk-provider-opencode-sdk';
const opencode = createOpencode({ autoStartServer: true, serverTimeout: 10000, defaultSettings: { agent: 'build', },});Provider settings:
- hostname string - Server hostname (default:
127.0.0.1). - port number - Server port (default:
4096). - autoStartServer boolean - Auto-start the OpenCode server (default:
true). - serverTimeout number - Server startup timeout in milliseconds (default:
10000). - defaultSettings object - Default settings applied to all model calls.
Language Models
Models are specified using the providerID/modelID format:
const model = opencode('anthropic/claude-sonnet-4-5-20250929');Model Shortcuts (exported as OpencodeModels):
import { OpencodeModels } from 'ai-sdk-provider-opencode-sdk';
// Anthropic Claudeopencode(OpencodeModels['claude-opus-4-5']); // anthropic/claude-opus-4-5-20251101opencode(OpencodeModels['claude-sonnet-4-5']); // anthropic/claude-sonnet-4-5-20250929opencode(OpencodeModels['claude-haiku-4-5']); // anthropic/claude-haiku-4-5-20251001
// OpenAI GPTopencode(OpencodeModels['gpt-4o']); // openai/gpt-4oopencode(OpencodeModels['gpt-4o-mini']); // openai/gpt-4o-mini
// Google Geminiopencode(OpencodeModels['gemini-3-pro']); // google/gemini-3-pro-previewopencode(OpencodeModels['gemini-2.5-pro']); // google/gemini-2.5-proopencode(OpencodeModels['gemini-2.5-flash']); // google/gemini-2.5-flashopencode(OpencodeModels['gemini-2.0-flash']); // google/gemini-2.0-flashYou can also use full model identifiers:
opencode('openai/gpt-5.1-codex');opencode('openai/gpt-5.1-codex-max');opencode('google/gemini-3-pro-preview');Example
import { opencode } from 'ai-sdk-provider-opencode-sdk';import { generateText } from 'ai';
const { text } = await generateText({ model: opencode('anthropic/claude-sonnet-4-5-20250929'), prompt: 'Write a vegetarian lasagna recipe for 4 people.',});Model Settings
const model = opencode('anthropic/claude-opus-4-5-20251101', { agent: 'build', // 'build' | 'plan' | 'general' | 'explore' sessionTitle: 'My Task', systemPrompt: 'You are a helpful assistant.',});Model Capabilities
| Provider | Image Input | Object Generation | Tool Usage | Tool Streaming |
|---|---|---|---|---|
| Anthropic | ||||
| OpenAI | ||||
Tool Usage and Tool Streaming show ❌ because this provider does not support
AI SDK custom tools (Zod schemas passed to generateText/streamText).
Custom tool definitions are explicitly ignored. OpenCode executes tools
server-side, which can be observed via streaming events. Image input supports
data URLs and base64 only. Object generation uses prompt-based JSON mode.
Server Management
OpenCode runs as a managed server. Make sure to dispose of the provider when done:
import { opencode } from 'ai-sdk-provider-opencode-sdk';
// After you're doneawait opencode.dispose();
// Or if you need direct access to the client manager:// await opencode.getClientManager().dispose();The client manager automatically cleans up on process exit (SIGINT, SIGTERM).
Requirements
- Node.js 18 or higher
- OpenCode CLI installed (
npm install -g opencode) - Provider credentials configured in OpenCode (Anthropic, OpenAI, or Google API keys)
For more details, see the provider documentation.