Skip to content

OPENCODE.md

Latest commit

 

History

History
163 lines (117 loc) · 12.7 KB

OPENCODE.md

File metadata and controls

163 lines (117 loc) · 12.7 KB
Raw

OpenCode Integration (עברית)

🌐 Languages: 🇺🇸 English · 🇪🇹 am · 🇸🇦 ar · 🇦🇿 az · 🇧🇬 bg · 🇧🇩 bn · 🇧🇦 bs · 🇨🇿 cs · 🇩🇰 da · 🇩🇪 de · 🇬🇷 el · 🇪🇸 es · 🇪🇪 et · 🇮🇷 fa · 🇫🇮 fi · 🇫🇷 fr · 🇮🇪 ga · 🇮🇳 gu · 🇳🇬 ha · 🇮🇳 hi · 🇭🇷 hr · 🇭🇺 hu · 🇦🇲 hy · 🇮🇩 id · 🇳🇬 ig · 🇮🇹 it · 🇯🇵 ja · 🇬🇪 ka · 🇰🇭 km · 🇮🇳 kn · 🇰🇷 ko · 🇱🇹 lt · 🇱🇻 lv · 🇮🇳 ml · 🇮🇳 mr · 🇲🇾 ms · 🇲🇹 mt · 🇲🇲 my · 🇳🇵 ne · 🇳🇱 nl · 🇳🇴 no · 🇮🇳 or · 🇮🇳 pa · 🇵🇭 phi · 🇵🇱 pl · 🇵🇹 pt · 🇧🇷 pt-BR · 🇷🇴 ro · 🇷🇺 ru · 🇱🇰 si · 🇸🇰 sk · 🇸🇮 sl · 🇷🇸 sr · 🇸🇪 sv · 🇰🇪 sw · 🇮🇳 ta · 🇮🇳 te · 🇹🇭 th · 🇹🇷 tr · 🇺🇦 uk-UA · 🇵🇰 ur · 🇺🇿 uz · 🇻🇳 vi · 🇳🇬 yo · 🇨🇳 zh-CN · 🇹🇼 zh-TW

סטטוס: זמין לכלל. קהל יעד: מפעילים המחברים את OpenCode לפריסת OmniRoute. מקור האמת (סכמת תצורה): src/shared/services/opencodeConfig.ts מקור האמת (חבילת npm): @omniroute/opencode-provider/ (מרחב עבודה הניתן לפרסום)

OpenCode הוא לקוח AI סוכני לממשק שורת הפקודה/לשולחן העבודה. הוא קורא את קטלוג הספקים שלו מתוך ~/.config/opencode/opencode.json (או opencode.jsonc) ופועל לפי הסכמה שבכתובת https://opencode.ai/config.json. OmniRoute חושף את עצמו ל-OpenCode כאחד מהספקים האלה — כל בקשה עוברת דרך ממשק /v1 הסטנדרטי ותואם-OpenAI של OmniRoute, כך ש-OpenCode נהנה אוטומטית מניתוב Auto-Combo, ממפסקי מעגל, ממדיניות מפתחות, מניטוריות וכו'.

ישנם שני נתיבי שילוב נתמכים. בחרו אחד מהם — שניהם יוצרים את אותה תצורה.

נתיב 1 — מחולל CLI (ללא התקנת npm)

מומלץ למשתמשי קצה. כלול ב-OmniRoute. כותב את opencode.json במקומו.

# לאחר התקנת OmniRoute‏ (npm i -g @omniroute/cli או שיבוט מקומי)
omniroute config opencode \
  --base-url http://localhost:20128 \
  --api-key "$OMNIROUTE_API_KEY"

מאחורי הקלעים, ה-CLI קורא ל-mergeOpenCodeConfigText() ‏(src/shared/services/opencodeConfig.ts:104), כך שקובץ opencode.json קיים שומר על הספקים וההערות האחרים שלו. הרשומה של OmniRoute נוספת או מוחלפת באופן אטומי.

הקובץ שנוצר (קטלוג המודלים המוגדר כברירת מחדל):

{
  "$schema": "https://opencode.ai/config.json",
  "provider": {
    "omniroute": {
      "npm": "@ai-sdk/openai-compatible",
      "name": "OmniRoute",
      "options": {
        "baseURL": "http://localhost:20128/v1",
        "apiKey": "<your-key>",
      },
      "models": {
        "claude-opus-4-5-thinking": { "name": "claude-opus-4-5-thinking" },
        "claude-sonnet-4-5-thinking": { "name": "claude-sonnet-4-5-thinking" },
        "gemini-3.1-pro-high": { "name": "gemini-3.1-pro-high" },
        "gemini-3-flash": { "name": "gemini-3-flash" },
      },
    },
  },
}

נתיב 2 — חבילת npm בשם @omniroute/opencode-provider

מומלץ כאשר אתם יוצרים את התצורה באמצעות סקריפט מ-Node/TS (תהליכי CI, מאגרים אחודים, תהליכי התקנה מותאמים אישית).

npm install --save-dev @omniroute/opencode-provider
import { writeFileSync } from "node:fs";
import { buildOmniRouteOpenCodeConfig } from "@omniroute/opencode-provider";

const config = buildOmniRouteOpenCodeConfig({
  baseURL: "http://localhost:20128",
  apiKey: process.env.OMNIROUTE_API_KEY ?? "sk_omniroute",
  // אופציונלי: החלפת קטלוג המודלים שנחשף ל-OpenCode
  models: ["auto", "claude-opus-4-7", "gpt-5.5"],
  modelLabels: { auto: "Auto-Combo" },
});

writeFileSync("opencode.json", JSON.stringify(config, null, 2));

כדי לבצע מיזוג שאינו הרסני עם קובץ קיים, שכפלו את mergeOpenCodeConfigText() מתוך opencodeConfig.ts או הפעילו את מחולל ה-CLI.

ראו את קובץ ה-README של החבילה לקבלת ה-API המלא.

מה סביבת הריצה עושה בפועל

שני הנתיבים יוצרים את אותו provider.omniroute.npm: "@ai-sdk/openai-compatible". בזמן הריצה, OpenCode טוען את @ai-sdk/openai-compatible (שכבר מהווה תלות טרנזיטיבית של OpenCode) ומגדיר אותו באמצעות baseURL + apiKey. משם:

ממשק המשתמש/הסוכן של OpenCode
   → @ai-sdk/openai-compatible
      → HTTP POST {baseURL}/chat/completions          (ממשק OpenAI של OmniRoute)
         → המטפל של OmniRoute עבור /v1/chat/completions     (open-sse/handlers/chatCore.ts)
            → ניתוב משולב / Auto-Combo / מנגנון ביצוע
               → ספק במעלה הזרם

התוסף לעולם אינו נוגע ב-HTTP. הוא רק מפיק תצורה.

ברירות המחדל של קטלוג המודלים

export const OMNIROUTE_DEFAULT_OPENCODE_MODELS = [
  "claude-opus-4-5-thinking",
  "claude-sonnet-4-5-thinking",
  "gemini-3.1-pro-high",
  "gemini-3-flash",
] as const;

ניתן לעקוף אותן באמצעות models: [...]. תוספות מומלצות:

  • "auto" — חושף את נתב Auto-Combo של OmniRoute, שאינו דורש הגדרות. מאפשר ל-OpenCode לבחור את "המודל הזמין הטוב ביותר" בלי לקבע את הקטלוג בקוד.
  • "<combo-name>" — כל שילוב שהגדרתם בלוח הבקרה; OmniRoute פותר אותו באופן שקוף.

נרמול כתובות URL

פונקציית העזר מקבלת את שתי הצורות ומפיקה /v1 אחד בדיוק:

קלט פלט (options.baseURL)
http://localhost:20128 http://localhost:20128/v1
http://localhost:20128/ http://localhost:20128/v1
http://localhost:20128/v1 http://localhost:20128/v1
http://localhost:20128/v1/// http://localhost:20128/v1

הסרת הכפילויות הזו היא התקלה הנפוצה ביותר שנצפתה בתצורות ישנות. אם יש לכם קובץ opencode.json מלפני v3.8.0 שמפנה אל /v1/v1/..., הפעילו מחדש את המחולל או קראו שוב ל-createOmniRouteProvider.

מצבי אימות

הגדרת OmniRoute ערך apiKey מומלץ
REQUIRE_API_KEY=false (ברירת המחדל מקומית) sk_omniroute (מציין מקום מילולי)
REQUIRE_API_KEY=true מפתח API אמיתי לכל משתמש מלוח הבקרה ← מפתחות API.

עבור לקוחות בסגנון Anthropic ששולחים x-api-key יחד עם anthropic-version, גם extractApiKey של OmniRoute מכבד את המפתח מ-x-api-key. OpenCode משתמש בממשק OpenAI, ולכן הוא תמיד ישלח Authorization: Bearer ${apiKey} — המקרה המיוחד של Anthropic אינו חל כאן.

פתרון בעיות

תסמין סיבה פתרון
404 בכל בקשה עם כתובת URL שמכילה /v1/v1/ תצורה מיושנת מתוסף שלפני v3.8 שהוסיף את הסיומת /v1 פעמיים. צרו מחדש באמצעות נתיב 1 או 2.
401 Invalid API key ב-OmniRoute מוגדר REQUIRE_API_KEY=true והמפתח אינו מוכר. צרו את המפתח בלוח הבקרה, או הגדירו REQUIRE_API_KEY=false (מקומי בלבד) והשתמשו ב-sk_omniroute.
רשימת המודלים ריקה בממשק המשתמש של OpenCode כל 4 מודלי ברירת המחדל מוסתרים בהגדרות הנראות של הספק ב-OmniRoute. העבירו models: ["auto", ...] כדי לחשוף את אלה שהפעלתם.
שגיאת 500 ב-OpenCode עם cannot read property 'models' גרסאות ישנות יותר של OpenCode (< 0.1.x) לא קיבלו models מוטבע. שדרגו את OpenCode לגרסה שתואמת לסכמת v1 (opencode.ai/config.json).

ראו גם