Back to Ai

OpenCode

content/providers/03-community-providers/31-opencode-sdk.mdx

2.1.105.3 KB
Original Source

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 VersionAI SDK VersionNPM TagStatus
1.xv6latestStable
0.xv5ai-sdk-v5Maintenance
bash
# AI SDK v6 (default)
npm install ai-sdk-provider-opencode-sdk ai

# AI SDK v5
npm install ai-sdk-provider-opencode-sdk@ai-sdk-v5 ai@^5.0.0

Setup

<Tabs items={['pnpm', 'npm', 'yarn', 'bun']}> <Tab> <Snippet text="pnpm add ai-sdk-provider-opencode-sdk" dark /> </Tab> <Tab> <Snippet text="npm install ai-sdk-provider-opencode-sdk" dark /> </Tab> <Tab> <Snippet text="yarn add ai-sdk-provider-opencode-sdk" dark /> </Tab> <Tab> <Snippet text="bun add ai-sdk-provider-opencode-sdk" dark /> </Tab> </Tabs>

Provider Instance

You can import the default provider instance opencode from ai-sdk-provider-opencode-sdk:

ts
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:

ts
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:

ts
const model = opencode('anthropic/claude-sonnet-4-5-20250929');

Model Shortcuts (exported as OpencodeModels):

ts
import { OpencodeModels } from 'ai-sdk-provider-opencode-sdk';

// Anthropic Claude
opencode(OpencodeModels['claude-opus-4-5']); // anthropic/claude-opus-4-5-20251101
opencode(OpencodeModels['claude-sonnet-4-5']); // anthropic/claude-sonnet-4-5-20250929
opencode(OpencodeModels['claude-haiku-4-5']); // anthropic/claude-haiku-4-5-20251001

// OpenAI GPT
opencode(OpencodeModels['gpt-4o']); // openai/gpt-4o
opencode(OpencodeModels['gpt-4o-mini']); // openai/gpt-4o-mini

// Google Gemini
opencode(OpencodeModels['gemini-3.1-pro-preview']); // google/gemini-3.1-pro-preview
opencode(OpencodeModels['gemini-2.5-pro']); // google/gemini-2.5-pro
opencode(OpencodeModels['gemini-2.5-flash']); // google/gemini-2.5-flash
opencode(OpencodeModels['gemini-2.0-flash']); // google/gemini-2.0-flash

You can also use full model identifiers:

ts
opencode('openai/gpt-5.1-codex');
opencode('openai/gpt-5.1-codex-max');
opencode('google/gemini-3.1-pro-preview');

Example

ts
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

ts
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

ProviderImage InputObject GenerationTool UsageTool Streaming
Anthropic<Check size={18} /><Check size={18} /><Cross size={18} /><Cross size={18} />
OpenAI<Check size={18} /><Check size={18} /><Cross size={18} /><Cross size={18} />
Google<Check size={18} /><Check size={18} /><Cross size={18} /><Cross size={18} />
<Note> 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. </Note>

Server Management

OpenCode runs as a managed server. Make sure to dispose of the provider when done:

ts
import { opencode } from 'ai-sdk-provider-opencode-sdk';

// After you're done
await 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.