File size: 22,279 Bytes
3e05655 | 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: عميل JavaScript آمن الأنواع لخادم opencode.
---
import config from "../../../../config.mjs"
export const typesUrl = `${config.github}/blob/dev/packages/sdk/js/src/gen/types.gen.ts`
توفر SDK الخاصة بـ opencode لـ JS/TS عميلا آمنا للأنواع للتفاعل مع الخادم.
استخدمها لبناء التكاملات والتحكم في opencode برمجيا.
[اعرف المزيد](/docs/server) حول كيفية عمل الخادم. للاطلاع على أمثلة، تفقد [المشاريع](/docs/ecosystem#projects) التي أنشأها المجتمع.
---
## التثبيت
ثبّت SDK من npm:
```bash
npm install @opencode-ai/sdk
```
---
## إنشاء عميل
أنشئ مثيلا من opencode:
```javascript
import { createOpencode } from "@opencode-ai/sdk"
const { client } = await createOpencode()
```
هذا يشغّل خادما وعميلا معا.
#### الخيارات
| الخيار | النوع | الوصف | الافتراضي |
| ---------- | ------------- | ----------------------------- | ----------- |
| `hostname` | `string` | اسم مضيف الخادم | `127.0.0.1` |
| `port` | `number` | منفذ الخادم | `4096` |
| `signal` | `AbortSignal` | إشارة إلغاء للإيقاف | `undefined` |
| `timeout` | `number` | مهلة بدء الخادم بالمللي ثانية | `5000` |
| `config` | `Config` | كائن الإعدادات | `{}` |
---
## الإعدادات
يمكنك تمرير كائن إعدادات لتخصيص السلوك. سيستمر المثيل في التقاط `opencode.json` لديك، لكن يمكنك تجاوز الإعدادات أو إضافة إعدادات مباشرة:
```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()
```
## العميل فقط
إذا كان لديك مثيل opencode يعمل بالفعل، يمكنك إنشاء مثيل عميل للاتصال به:
```javascript
import { createOpencodeClient } from "@opencode-ai/sdk"
const client = createOpencodeClient({
baseUrl: "http://localhost:4096",
})
```
#### الخيارات
| الخيار | النوع | الوصف | الافتراضي |
| --------------- | ---------- | --------------------------------- | ----------------------- |
| `baseUrl` | `string` | عنوان URL للخادم | `http://localhost:4096` |
| `fetch` | `function` | تنفيذ fetch مخصص | `globalThis.fetch` |
| `parseAs` | `string` | طريقة تحليل الاستجابة | `auto` |
| `responseStyle` | `string` | أسلوب الإرجاع: `data` أو `fields` | `fields` |
| `throwOnError` | `boolean` | رمي الأخطاء بدلا من إرجاعها | `false` |
---
## الأنواع
تتضمن SDK تعريفات TypeScript لجميع أنواع API. استوردها مباشرة:
```typescript
import type { Session, Message, Part } from "@opencode-ai/sdk"
```
جميع الأنواع مولّدة من مواصفات OpenAPI الخاصة بالخادم ومتاحة في <a href={typesUrl}>ملف الأنواع</a>.
---
## الأخطاء
يمكن أن ترمي SDK أخطاء يمكنك التقاطها ومعالجتها:
```typescript
try {
await client.session.get({ path: { id: "invalid-id" } })
} catch (error) {
console.error("Failed to get session:", (error as Error).message)
}
```
---
## المخرجات المنظمة
يمكنك طلب مخرجات JSON منظمة من النموذج عن طريق تحديد `format` مع مخطط JSON. سيستخدم النموذج أداة `StructuredOutput` لإرجاع JSON تم التحقق من صحته ومطابق للمخطط الخاص بك.
### الاستخدام الأساسي
```typescript
const result = await client.session.prompt({
path: { id: sessionId },
body: {
parts: [{ type: "text", text: "Research Anthropic and provide company info" }],
format: {
type: "json_schema",
schema: {
type: "object",
properties: {
company: { type: "string", description: "Company name" },
founded: { type: "number", description: "Year founded" },
products: {
type: "array",
items: { type: "string" },
description: "Main products",
},
},
required: ["company", "founded"],
},
},
},
})
// Access the structured output
console.log(result.data.info.structured_output)
// { company: "Anthropic", founded: 2021, products: ["Claude", "Claude API"] }
```
### أنواع صيغ الإخراج
| النوع | الوصف |
| ------------- | -------------------------------------------------- |
| `text` | الافتراضي. استجابة نصية قياسية (بدون مخرجات منظمة) |
| `json_schema` | يرجع JSON تم التحقق من صحته ومطابق للمخطط المقدم |
### صيغة مخطط JSON
عند استخدام `type: 'json_schema'`، يجب تقديم:
| الحقل | النوع | الوصف |
| ------------ | --------------- | ------------------------------------------------ |
| `type` | `'json_schema'` | مطلوب. يحدد وضع مخطط JSON |
| `schema` | `object` | مطلوب. كائن مخطط JSON الذي يحدد بنية الإخراج |
| `retryCount` | `number` | اختياري. عدد محاولات إعادة التحقق (الافتراضي: 2) |
### معالجة الأخطاء
إذا فشل النموذج في إنتاج مخرجات منظمة صالحة بعد جميع المحاولات، ستتضمن الاستجابة `StructuredOutputError`:
```typescript
if (result.data.info.error?.name === "StructuredOutputError") {
console.error("Failed to produce structured output:", result.data.info.error.message)
console.error("Attempts:", result.data.info.error.retries)
}
```
### أفضل الممارسات
1. **قدّم أوصافا واضحة** في خصائص المخطط لمساعدة النموذج على فهم البيانات التي يجب استخراجها
2. **استخدم `required`** لتحديد الحقول التي يجب أن تكون موجودة
3. **حافظ على تركيز المخططات** - المخططات المتداخلة المعقدة قد تكون أصعب على النموذج لملئها بشكل صحيح
4. **عيّن `retryCount` مناسبا** - قم بزيادته للمخططات المعقدة، وتقليله للمخططات البسيطة
---
## APIs
توفر SDK جميع واجهات الخادم عبر عميل آمن للأنواع.
---
### عام (`global`)
| الطريقة | الوصف | الاستجابة |
| ----------------- | ---------------------------- | ------------------------------------ |
| `global.health()` | التحقق من صحة الخادم وإصداره | `{ healthy: true, version: string }` |
---
#### أمثلة
```javascript
const health = await client.global.health()
console.log(health.data.version)
```
---
### التطبيق (`app`)
| الطريقة | الوصف | الاستجابة |
| -------------- | ------------------------- | ------------------------------------------- |
| `app.log()` | كتابة إدخال في السجل | `boolean` |
| `app.agents()` | سرد جميع الوكلاء المتاحين | <a href={typesUrl}><code>Agent[]</code></a> |
---
#### أمثلة
```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`)
| الطريقة | الوصف | الاستجابة |
| ------------------- | ------------------ | --------------------------------------------- |
| `project.list()` | سرد جميع المشاريع | <a href={typesUrl}><code>Project[]</code></a> |
| `project.current()` | جلب المشروع الحالي | <a href={typesUrl}><code>Project</code></a> |
---
#### أمثلة
```javascript
// List all projects
const projects = await client.project.list()
// Get current project
const currentProject = await client.project.current()
```
---
### المسار (`path`)
| الطريقة | الوصف | الاستجابة |
| ------------ | ----------------- | ---------------------------------------- |
| `path.get()` | جلب المسار الحالي | <a href={typesUrl}><code>Path</code></a> |
---
#### أمثلة
```javascript
// Get current path information
const pathInfo = await client.path.get()
```
---
### الإعدادات (`config`)
| الطريقة | الوصف | الاستجابة |
| -------------------- | --------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `config.get()` | جلب معلومات الإعدادات | <a href={typesUrl}><code>Config</code></a> |
| `config.providers()` | سرد المزوّدين والنماذج الافتراضية | `{ providers: `<a href={typesUrl}><code>Provider[]</code></a>`, default: { [key: string]: string } }` |
---
#### أمثلة
```javascript
const config = await client.config.get()
const { providers, default: defaults } = await client.config.providers()
```
---
### الجلسات (`session`)
| الطريقة | الوصف | ملاحظات |
| ---------------------------------------------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `session.list()` | سرد الجلسات | يعيد <a href={typesUrl}><code>Session[]</code></a> |
| `session.get({ path })` | جلب جلسة | يعيد <a href={typesUrl}><code>Session</code></a> |
| `session.children({ path })` | سرد الجلسات الفرعية | يعيد <a href={typesUrl}><code>Session[]</code></a> |
| `session.create({ body })` | إنشاء جلسة | يعيد <a href={typesUrl}><code>Session</code></a> |
| `session.delete({ path })` | حذف جلسة | يعيد `boolean` |
| `session.update({ path, body })` | تحديث خصائص الجلسة | يعيد <a href={typesUrl}><code>Session</code></a> |
| `session.init({ path, body })` | تحليل التطبيق وإنشاء `AGENTS.md` | يعيد `boolean` |
| `session.abort({ path })` | إيقاف جلسة قيد التشغيل | يعيد `boolean` |
| `session.share({ path })` | مشاركة جلسة | يعيد <a href={typesUrl}><code>Session</code></a> |
| `session.unshare({ path })` | إلغاء مشاركة جلسة | يعيد <a href={typesUrl}><code>Session</code></a> |
| `session.summarize({ path, body })` | تلخيص جلسة | يعيد `boolean` |
| `session.messages({ path })` | سرد الرسائل في جلسة | يعيد `{ info: `<a href={typesUrl}><code>Message</code></a>`, parts: `<a href={typesUrl}><code>Part[]</code></a>`}[]` |
| `session.message({ path })` | جلب تفاصيل الرسالة | يعيد `{ info: `<a href={typesUrl}><code>Message</code></a>`, parts: `<a href={typesUrl}><code>Part[]</code></a>`}` |
| `session.prompt({ path, body })` | إرسال رسالة مطالبة | `body.noReply: true` يعيد UserMessage (للسياق فقط). الافتراضي يعيد <a href={typesUrl}><code>AssistantMessage</code></a> مع استجابة AI. يدعم `body.outputFormat` من أجل [المخرجات المنظمة](#المخرجات-المنظمة) |
| `session.command({ path, body })` | إرسال أمر إلى الجلسة | يعيد `{ info: `<a href={typesUrl}><code>AssistantMessage</code></a>`, parts: `<a href={typesUrl}><code>Part[]</code></a>`}` |
| `session.shell({ path, body })` | تشغيل أمر shell | يعيد <a href={typesUrl}><code>AssistantMessage</code></a> |
| `session.revert({ path, body })` | التراجع عن رسالة | يعيد <a href={typesUrl}><code>Session</code></a> |
| `session.unrevert({ path })` | استعادة الرسائل المتراجع عنها | يعيد <a href={typesUrl}><code>Session</code></a> |
| `postSessionByIdPermissionsByPermissionId({ path, body })` | الاستجابة لطلب إذن | يعيد `boolean` |
---
#### أمثلة
```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." }],
},
})
```
---
### الملفات
| الطريقة | الوصف | الاستجابة |
| ------------------------- | ----------------------------------- | -------------------------------------------------------------------------------------------- |
| `find.text({ query })` | البحث عن نص داخل الملفات | مصفوفة من كائنات المطابقة مع `path` و`lines` و`line_number` و`absolute_offset` و`submatches` |
| `find.files({ query })` | العثور على الملفات والمجلدات بالاسم | `string[]` (مسارات) |
| `find.symbols({ query })` | العثور على رموز مساحة العمل | <a href={typesUrl}><code>Symbol[]</code></a> |
| `file.read({ query })` | قراءة ملف | `{ type: "raw" \| "patch", content: string }` |
| `file.status({ query? })` | جلب حالة الملفات المتتبَّعة | <a href={typesUrl}><code>File[]</code></a> |
يدعم `find.files` بعض حقول الاستعلام الاختيارية:
- `type`: `"file"` أو `"directory"`
- `directory`: تجاوز جذر المشروع لعملية البحث
- `limit`: الحد الأقصى للنتائج (1–200)
---
#### أمثلة
```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 (`tui`)
| الطريقة | الوصف | الاستجابة |
| ------------------------------ | ---------------------- | --------- |
| `tui.appendPrompt({ body })` | إلحاق نص بالمطالبة | `boolean` |
| `tui.openHelp()` | فتح مربع حوار المساعدة | `boolean` |
| `tui.openSessions()` | فتح محدد الجلسات | `boolean` |
| `tui.openThemes()` | فتح محدد السمات | `boolean` |
| `tui.openModels()` | فتح محدد النماذج | `boolean` |
| `tui.submitPrompt()` | إرسال المطالبة الحالية | `boolean` |
| `tui.clearPrompt()` | مسح المطالبة | `boolean` |
| `tui.executeCommand({ body })` | تنفيذ أمر | `boolean` |
| `tui.showToast({ body })` | عرض إشعار toast | `boolean` |
---
#### أمثلة
```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`)
| الطريقة | الوصف | الاستجابة |
| ------------------- | ---------------------------- | --------- |
| `auth.set({ ... })` | تعيين بيانات اعتماد المصادقة | `boolean` |
---
#### أمثلة
```javascript
await client.auth.set({
path: { id: "anthropic" },
body: { type: "api", key: "your-api-key" },
})
```
---
### الأحداث (`event`)
| الطريقة | الوصف | الاستجابة |
| ------------------- | -------------------------- | -------------------------- |
| `event.subscribe()` | تدفق أحداث مرسلة من الخادم | تدفق أحداث مرسلة من الخادم |
---
#### أمثلة
```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)
}
```
|