summaryrefslogtreecommitdiffhomepage
path: root/packages
diff options
context:
space:
mode:
authorDax Raad <[email protected]>2025-09-02 15:16:35 -0400
committerDax Raad <[email protected]>2025-09-02 16:38:50 -0400
commit38a4bee1be856fb3a06cfab4bad4a5b15b09f0a2 (patch)
tree85fdfb6f7149acd82b7c5077a62121efe4002313 /packages
parent8952b3d246a6282e7f2059312d52a69f16432259 (diff)
downloadopencode-38a4bee1be856fb3a06cfab4bad4a5b15b09f0a2.tar.gz
opencode-38a4bee1be856fb3a06cfab4bad4a5b15b09f0a2.zip
docs: add config example to SDK server creation
Diffstat (limited to 'packages')
-rw-r--r--packages/web/src/content/docs/docs/sdk.mdx26
1 files changed, 26 insertions, 0 deletions
diff --git a/packages/web/src/content/docs/docs/sdk.mdx b/packages/web/src/content/docs/docs/sdk.mdx
index 1e537362f..40cb6d21e 100644
--- a/packages/web/src/content/docs/docs/sdk.mdx
+++ b/packages/web/src/content/docs/docs/sdk.mdx
@@ -65,6 +65,31 @@ console.log(`Server running at ${server.url}`)
server.close()
```
+You can also pass a configuration object to customize the server behavior:
+
+```javascript
+import { createOpencodeServer } from "@opencode-ai/sdk"
+
+const server = await createOpencodeServer({
+ hostname: "127.0.0.1",
+ port: 4096,
+ config: {
+ theme: "dark",
+ model: "anthropic/claude-3-5-sonnet-20241022",
+ agent: {
+ general: {
+ temperature: 0.7,
+ model: "anthropic/claude-3-5-sonnet-20241022",
+ },
+ },
+ },
+})
+
+console.log(`Server running at ${server.url}`)
+
+server.close()
+```
+
#### Options
| Option | Type | Description | Default |
@@ -73,6 +98,7 @@ server.close()
| `port` | `number` | Server port | `4096` |
| `signal` | `AbortSignal` | Abort signal for cancellation | `undefined` |
| `timeout` | `number` | Timeout in ms for server start | `5000` |
+| `config` | `Config` | Configuration object | `{}` |
---