File size: 21,740 Bytes
0dbc9de | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 | ---
title: SDK
description: opencode sunucusu için type-safe JS istemcisi.
---
import config from "../../../../config.mjs"
export const typesUrl = `${config.github}/blob/dev/packages/sdk/js/src/gen/types.gen.ts`
opencode JS/TS SDK, sunucu ile etkileşmek için type-safe bir istemci sağlar.
opencode'u programatik olarak kontrol etmek ve entegrasyonlar oluşturmak için kullanabilirsiniz.
[Sunucu](/docs/server) sayfasında nasıl çalıştığını görebilir, örnekler için topluluğun oluşturduğu [projeler](/docs/ecosystem#projects) bölümüne bakabilirsiniz.
---
## Kurulum
SDK'yı npm'den yükleyin:
```bash
npm install @opencode-ai/sdk
```
---
## İstemci Oluşturma
Bir opencode örneği oluşturun:
```javascript
import { createOpencode } from "@opencode-ai/sdk"
const { client } = await createOpencode()
```
Bu, hem bir sunucu hem de bir istemci başlatır
#### Seçenekler
| Seçenek | Tip | Açıklama | Varsayılan |
| ---------- | ------------- | --------------------------------------------- | ----------- |
| `hostname` | `string` | Sunucu ana bilgisayar adı | `127.0.0.1` |
| `port` | `number` | Sunucu bağlantı noktası | `4096` |
| `signal` | `AbortSignal` | İptal için durdurma sinyali | `undefined` |
| `timeout` | `number` | Sunucu başlatma için ms cinsinden zaman aşımı | `5000` |
| `config` | `Config` | Yapılandırma nesnesi | `{}` |
---
## Yapılandırma
Davranışı özelleştirmek için bir yapılandırma nesnesi iletebilirsiniz. Örnek yine de `opencode.json` dosyanızı alır, ancak yapılandırmayı satır içi olarak geçersiz kılabilir veya ekleyebilirsiniz:
```javascript
import { createOpencode } from "@opencode-ai/sdk"
const opencode = await createOpencode({
hostname: "127.0.0.1",
port: 4096,
config: {
model: "anthropic/claude-3-5-sonnet-20241022",
},
})
console.log(`Server running at ${opencode.server.url}`)
opencode.server.close()
```
## Yalnızca istemci
Halihazırda çalışan bir opencode örneğiniz varsa, ona bağlanmak için bir istemci örneği oluşturabilirsiniz:
```javascript
import { createOpencodeClient } from "@opencode-ai/sdk"
const client = createOpencodeClient({
baseUrl: "http://localhost:4096",
})
```
#### Seçenekler
| Seçenek | Tip | Açıklama | Varsayılan |
| --------------- | ---------- | --------------------------------- | ----------------------- |
| `baseUrl` | `string` | Sunucunun URL'si | `http://localhost:4096` |
| `fetch` | `function` | Özel fetch uygulaması | `globalThis.fetch` |
| `parseAs` | `string` | Yanıt ayrıştırma yöntemi | `auto` |
| `responseStyle` | `string` | Dönüş stili: `data` veya `fields` | `fields` |
| `throwOnError` | `boolean` | Dönüş yerine hata fırlat | `false` |
---
## Türler
SDK, tüm API türleri için TypeScript tanımlarını içerir. Bunları doğrudan içe aktarın:
```typescript
import type { Session, Message, Part } from "@opencode-ai/sdk"
```
Tüm tipler, sunucunun OpenAPI spesifikasyonundan oluşturulur ve <a href={typesUrl}>tipler dosyasında</a> mevcuttur.
---
## Hatalar
SDK, yakalayabileceğiniz ve işleyebileceğiniz hatalar fırlatabilir:
```typescript
try {
await client.session.get({ path: { id: "invalid-id" } })
} catch (error) {
console.error("Failed to get session:", (error as Error).message)
}
```
---
## Yapılandırılmış Çıktı
Bir JSON şeması ile `format` belirterek modelden yapılandırılmış JSON çıktısı isteyebilirsiniz. Model, şemanızla eşleşen doğrulanmış JSON'u döndürmek için bir `StructuredOutput` aracı kullanacaktır.
### Temel Kullanım
```typescript
const result = await client.session.prompt({
path: { id: sessionId },
body: {
parts: [{ type: "text", text: "Anthropic'i araştırın ve şirket bilgileri sağlayın" }],
format: {
type: "json_schema",
schema: {
type: "object",
properties: {
company: { type: "string", description: "Şirket adı" },
founded: { type: "number", description: "Kuruluş yılı" },
products: {
type: "array",
items: { type: "string" },
description: "Ana ürünler",
},
},
required: ["company", "founded"],
},
},
},
})
// Yapılandırılmış çıktıya erişin
console.log(result.data.info.structured_output)
// { company: "Anthropic", founded: 2021, products: ["Claude", "Claude API"] }
```
### Çıktı Format Türleri
| Tür | Açıklama |
| ------------- | ------------------------------------------------------------- |
| `text` | Varsayılan. Standart metin yanıtı (yapılandırılmış çıktı yok) |
| `json_schema` | Sağlanan şema ile eşleşen doğrulanmış JSON döndürür |
### JSON Şema Formatı
`type: 'json_schema'` kullanırken şunları sağlayın:
| Alan | Tür | Açıklama |
| ------------ | --------------- | ------------------------------------------------------------- |
| `type` | `'json_schema'` | Gerekli. JSON şema modunu belirtir |
| `schema` | `object` | Gerekli. Çıktı yapısını tanımlayan JSON Şema nesnesi |
| `retryCount` | `number` | İsteğe bağlı. Doğrulama yeniden deneme sayısı (varsayılan: 2) |
### Hata Yönetimi
Model, tüm yeniden denemelerden sonra geçerli bir yapılandırılmış çıktı üretemezse, yanıt bir `StructuredOutputError` içerecektir:
```typescript
if (result.data.info.error?.name === "StructuredOutputError") {
console.error("Yapılandırılmış çıktı üretilemedi:", result.data.info.error.message)
console.error("Denemeler:", result.data.info.error.retries)
}
```
### En İyi Uygulamalar
1. **Açık açıklamalar sağlayın**: Modelin hangi verileri çıkaracağını anlamasına yardımcı olmak için şema özelliklerinde
2. **`required` kullanın**: Hangi alanların mevcut olması gerektiğini belirtmek için
3. **Şemaları odaklı tutun**: Karmaşık iç içe geçmiş şemaların model tarafından doğru doldurulması daha zor olabilir
4. **Uygun `retryCount` ayarlayın**: Karmaşık şemalar için artırın, basit olanlar için azaltın
---
## API'ler
SDK, tüm sunucu API'lerini type-safe bir istemci aracılığıyla sunar.
---
### Global
| Yöntem | Açıklama | Yanıt |
| ----------------- | --------------------------------------- | ------------------------------------ |
| `global.health()` | Sunucu sağlığını ve sürümünü kontrol et | `{ healthy: true, version: string }` |
---
#### Örnekler
```javascript
const health = await client.global.health()
console.log(health.data.version)
```
---
### App
| Yöntem | Açıklama | Yanıt |
| -------------- | ----------------------------- | ------------------------------------------- |
| `app.log()` | Bir günlük girdisi yaz | `boolean` |
| `app.agents()` | Tüm mevcut agent'ları listele | <a href={typesUrl}><code>Agent[]</code></a> |
---
#### Örnekler
```javascript
// Write a log entry
await client.app.log({
body: {
service: "my-app",
level: "info",
message: "Operation completed",
},
})
// List available agents
const agents = await client.app.agents()
```
---
### Project
| Yöntem | Açıklama | Yanıt |
| ------------------- | --------------------- | --------------------------------------------- |
| `project.list()` | Tüm projeleri listele | <a href={typesUrl}><code>Project[]</code></a> |
| `project.current()` | Mevcut projeyi al | <a href={typesUrl}><code>Project</code></a> |
---
#### Örnekler
```javascript
// List all projects
const projects = await client.project.list()
// Get current project
const currentProject = await client.project.current()
```
---
### Path
| Yöntem | Açıklama | Yanıt |
| ------------ | -------------- | ---------------------------------------- |
| `path.get()` | Mevcut yolu al | <a href={typesUrl}><code>Path</code></a> |
---
#### Örnekler
```javascript
// Get current path information
const pathInfo = await client.path.get()
```
---
### Config
| Yöntem | Açıklama | Yanıt |
| -------------------- | --------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `config.get()` | Yapılandırma bilgisini al | <a href={typesUrl}><code>Config</code></a> |
| `config.providers()` | Sağlayıcıları ve varsayılan modelleri listele | `{ providers: `<a href={typesUrl}><code>Provider[]</code></a>`, default: { [key: string]: string } }` |
---
#### Örnekler
```javascript
const config = await client.config.get()
const { providers, default: defaults } = await client.config.providers()
```
---
### Oturumlar
| Yöntem | Açıklama | Notlar |
| ---------------------------------------------------------- | ------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `session.list()` | Oturumları listele | <a href={typesUrl}><code>Session[]</code></a> döndürür |
| `session.get({ path })` | Oturum al | <a href={typesUrl}><code>Session</code></a> döndürür |
| `session.children({ path })` | Alt oturumları listele | <a href={typesUrl}><code>Session[]</code></a> döndürür |
| `session.create({ body })` | Oturum oluştur | <a href={typesUrl}><code>Session</code></a> döndürür |
| `session.delete({ path })` | Oturum sil | `boolean` döndürür |
| `session.update({ path, body })` | Oturum özelliklerini güncelle | <a href={typesUrl}><code>Session</code></a> döndürür |
| `session.init({ path, body })` | Uygulamayı analiz et ve `AGENTS.md` oluştur | `boolean` döndürür |
| `session.abort({ path })` | Çalışan bir oturumu iptal et | `boolean` döndürür |
| `session.share({ path })` | Oturum paylaş | <a href={typesUrl}><code>Session</code></a> döndürür |
| `session.unshare({ path })` | Oturum paylaşımını kaldır | <a href={typesUrl}><code>Session</code></a> döndürür |
| `session.summarize({ path, body })` | Oturumu özetle | `boolean` döndürür |
| `session.messages({ path })` | Oturumdaki mesajları listele | `{ info: `<a href={typesUrl}><code>Message</code></a>`, parts: `<a href={typesUrl}><code>Part[]</code></a>`}[]` döndürür |
| `session.message({ path })` | Mesaj ayrıntılarını al | `{ info: `<a href={typesUrl}><code>Message</code></a>`, parts: `<a href={typesUrl}><code>Part[]</code></a>`}` döndürür |
| `session.prompt({ path, body })` | İstem mesajı gönder | `body.noReply: true` UserMessage (yalnızca bağlam) döndürür. Varsayılan olarak AI yanıtıyla <a href={typesUrl}><code>AssistantMessage</code></a> döndürür. [yapılandırılmış çıktı](#yapılandırılmış-çıktı) için `body.outputFormat` destekler |
| `session.command({ path, body })` | Oturuma komut gönder | `{ info: `<a href={typesUrl}><code>AssistantMessage</code></a>`, parts: `<a href={typesUrl}><code>Part[]</code></a>`}` döndürür |
| `session.shell({ path, body })` | Bir kabuk komutu çalıştır | <a href={typesUrl}><code>AssistantMessage</code></a> döndürür |
| `session.revert({ path, body })` | Bir mesajı geri al | <a href={typesUrl}><code>Session</code></a> döndürür |
| `session.unrevert({ path })` | Geri alınan mesajları geri yükle | <a href={typesUrl}><code>Session</code></a> döndürür |
| `postSessionByIdPermissionsByPermissionId({ path, body })` | Bir izin isteğine yanıt ver | `boolean` döndürür |
---
#### Örnekler
```javascript
// Create and manage sessions
const session = await client.session.create({
body: { title: "My session" },
})
const sessions = await client.session.list()
// Send a prompt message
const result = await client.session.prompt({
path: { id: session.id },
body: {
model: { providerID: "anthropic", modelID: "claude-3-5-sonnet-20241022" },
parts: [{ type: "text", text: "Hello!" }],
},
})
// Inject context without triggering AI response (useful for plugins)
await client.session.prompt({
path: { id: session.id },
body: {
noReply: true,
parts: [{ type: "text", text: "You are a helpful assistant." }],
},
})
```
---
### Dosyalar
| Yöntem | Açıklama | Yanıt |
| ------------------------- | -------------------------------- | ----------------------------------------------------------------------------------------------- |
| `find.text({ query })` | Dosyalarda metin ara | `path`, `lines`, `line_number`, `absolute_offset`, `submatches` içeren eşleşme nesneleri dizisi |
| `find.files({ query })` | Dosya ve dizinleri isme göre bul | `string[]` (yollar) |
| `find.symbols({ query })` | Çalışma alanı sembollerini bul | <a href={typesUrl}><code>Symbol[]</code></a> |
| `file.read({ query })` | Bir dosyayı oku | `{ type: "raw" \| "patch", content: string }` |
| `file.status({ query? })` | İzlenen dosyalar için durumu al | <a href={typesUrl}><code>File[]</code></a> |
`find.files` birkaç isteğe bağlı sorgu alanını destekler:
- `type`: `"file"` veya `"directory"`
- `directory`: arama için proje kökünü geçersiz kılma
- `limit`: maksimum sonuç (1-200)
---
#### Örnekler
```javascript
// Search and read files
const textResults = await client.find.text({
query: { pattern: "function.*opencode" },
})
const files = await client.find.files({
query: { query: "*.ts", type: "file" },
})
const directories = await client.find.files({
query: { query: "packages", type: "directory", limit: 20 },
})
const content = await client.file.read({
query: { path: "src/index.ts" },
})
```
---
### TUI
| Yöntem | Açıklama | Yanıt |
| ------------------------------ | --------------------------- | --------- |
| `tui.appendPrompt({ body })` | İsteme metin ekle | `boolean` |
| `tui.openHelp()` | Yardım iletişim kutusunu aç | `boolean` |
| `tui.openSessions()` | Oturum seçiciyi aç | `boolean` |
| `tui.openThemes()` | Tema seçiciyi aç | `boolean` |
| `tui.openModels()` | Model seçiciyi aç | `boolean` |
| `tui.submitPrompt()` | Mevcut istemi gönder | `boolean` |
| `tui.clearPrompt()` | İstemi temizle | `boolean` |
| `tui.executeCommand({ body })` | Bir komut çalıştır | `boolean` |
| `tui.showToast({ body })` | Toast bildirimi göster | `boolean` |
---
#### Örnekler
```javascript
// Control TUI interface
await client.tui.appendPrompt({
body: { text: "Add this to prompt" },
})
await client.tui.showToast({
body: { message: "Task completed", variant: "success" },
})
```
---
### Auth
| Yöntem | Açıklama | Yanıt |
| ------------------- | ------------------------- | --------- |
| `auth.set({ ... })` | Kimlik bilgilerini ayarla | `boolean` |
---
#### Örnekler
```javascript
await client.auth.set({
path: { id: "anthropic" },
body: { type: "api", key: "your-api-key" },
})
```
---
### Olaylar
| Yöntem | Açıklama | Yanıt |
| ------------------- | --------------------------------------- | --------------------------------------- |
| `event.subscribe()` | Sunucu tarafından gönderilen olay akışı | Sunucu tarafından gönderilen olay akışı |
---
#### Örnekler
```javascript
// Listen to real-time events
const events = await client.event.subscribe()
for await (const event of events.stream) {
console.log("Event:", event.type, event.properties)
}
```
|