summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorDax Raad <[email protected]>2025-06-14 14:45:59 -0400
committerDax Raad <[email protected]>2025-06-14 14:45:59 -0400
commit89b95be4de64babe7050ccc2ed51adaaf208b15f (patch)
treede3cbf391399d6bdba14ff856c0066b47f3acfe0
parenteaf295bac736676e01f2bcf8ef425adf52698deb (diff)
downloadopencode-89b95be4de64babe7050ccc2ed51adaaf208b15f.tar.gz
opencode-89b95be4de64babe7050ccc2ed51adaaf208b15f.zip
docs: provider config
-rw-r--r--README.md28
1 files changed, 27 insertions, 1 deletions
diff --git a/README.md b/README.md
index 60e0d2f0c..2f19371e1 100644
--- a/README.md
+++ b/README.md
@@ -55,6 +55,32 @@ Project configuration is optional. You can place an `opencode.json` file in the
}
```
+### Providers
+
+You can use opencode with any provider listed at [here](https://ai-sdk.dev/providers/ai-sdk-providers). Use the npm package name as the key in your config. Note we use v5 of the ai-sdk and not all providers support that yet.
+
+```json title="opencode.json"
+{
+ "$schema": "http://opencode.ai/config.json",
+ "provider": {
+ "@ai-sdk/openai-compatible": {
+ "name": "MySpecialProvider",
+ "options": {
+ "apiKey": "xxx",
+ "baseURL": "https://api.provider.com/v1"
+ },
+ "models": {
+ "my-model-name": {
+ "name": "My Model Name"
+ }
+ }
+ }
+ }
+}
+```
+
+#### Provider Options
+
#### MCP
```json title="opencode.json"
@@ -108,7 +134,7 @@ Theoretically you can use this with OpenRouter with config like this
},
"models": {
"anthropic/claude-3.5-sonnet": {
- "name": "claude-3.5-sonnet"
+ "name": "Claude 3.5 Sonnet"
}
}
}