Files
OmniRoute/docs/i18n/pt-BR/docs/frameworks/OPENCODE.md
Diego Rodrigues de Sa e Souza 8feea123bb feat(docs): mirror every docs/ page in all 65 locales (#14106)
* feat(docs): mirror every docs/ page in all 65 locales

Extends the documentation mirrors from the 22-page core set (#13940) to
every Markdown page under docs/: 152 sources x 65 locales = 9,880 mirrors
(6,208 new), language bars rewritten for the full locale list, state
adopted so the blocking drift gate now covers all 152 pages.

run-translation.mjs: an oversized block made only of table rows or list
items (PROVIDER_REFERENCE.md 244-row table, FREE_TIERS.md 71-item list) is
cut at item boundaries and rejoined without a blank line — the single
16-40 KB request outlived the backend socket for verbose scripts. 48
older mirrors whose tables had lost rows were retranslated with --force.

* docs(i18n): refresh mirrors for the sources the base changed since the branch cut

Section-level retranslation of the 29 docs (and README.md) whose source
or mirrors moved on release/v3.8.51 during the run, then state adoption;
the drift gate is green again on the merged tree.
2026-09-18 13:16:46 -03:00

12 KiB

OpenCode Integration (Português (Brasil))

🌐 Languages: 🇺🇸 English · 🇪🇹 am · 🇸🇦 ar · 🇦🇿 az · 🇧🇬 bg · 🇧🇩 bn · 🇨🇿 cs · 🇩🇰 da · 🇩🇪 de · 🇬🇷 el · 🇪🇸 es · 🇪🇪 et · 🇮🇷 fa · 🇫🇮 fi · 🇫🇷 fr · 🇮🇪 ga · 🇮🇳 gu · 🇳🇬 ha · 🇮🇱 he · 🇮🇳 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 · 🇷🇴 ro · 🇷🇺 ru · 🇱🇰 si · 🇸🇰 sk · 🇸🇮 sl · 🇷🇸 sr · 🇸🇪 sv · 🇰🇪 sw · 🇮🇳 ta · 🇮🇳 te · 🇹🇭 th · 🇹🇷 tr · 🇺🇦 uk-UA · 🇵🇰 ur · 🇺🇿 uz · 🇻🇳 vi · 🇳🇬 yo · 🇨🇳 zh-CN · 🇹🇼 zh-TW


Status: Disponível de forma geral. Público: Operadores conectando o OpenCode a uma implantação do OmniRoute. Fonte da verdade (esquema de configuração): src/shared/services/opencodeConfig.ts Fonte da verdade (pacote npm): @omniroute/opencode-provider/ (workspace publicável)

O OpenCode é um cliente de IA agêntico para CLI/desktop. Ele lê seu catálogo de provedores de ~/.config/opencode/opencode.json (ou opencode.jsonc) e segue o esquema em https://opencode.ai/config.json. O OmniRoute se apresenta ao OpenCode como um desses provedores — todas as solicitações passam pela interface /v1 padrão do OmniRoute, compatível com OpenAI, portanto o OpenCode se beneficia automaticamente do roteamento Auto-Combo, circuit breakers, políticas de chaves, observabilidade etc.

dois caminhos de integração compatíveis. Escolha um — ambos geram a mesma configuração.


Caminho 1 — Gerador via CLI (sem instalar via npm)

Recomendado para usuários finais. Incluído no OmniRoute. Grava opencode.json no local.

# Após instalar o OmniRoute (npm i -g @omniroute/cli ou clone local)
omniroute config opencode \
  --base-url http://localhost:20128 \
  --api-key "$OMNIROUTE_API_KEY"

Nos bastidores, a CLI chama mergeOpenCodeConfigText() (src/shared/services/opencodeConfig.ts:104), portanto um opencode.json existente mantém seus outros provedores e comentários. A entrada do OmniRoute é adicionada/substituída de forma atômica.

Arquivo resultante (catálogo de modelos padrão):

{
  "$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" },
      },
    },
  },
}

Caminho 2 — Pacote npm @omniroute/opencode-provider

Recomendado ao gerar a configuração por scripts em Node/TS (pipelines de CI, monorepos, fluxos de instalação personalizados).

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",
  // Opcional: substitua o catálogo de modelos exposto ao OpenCode
  models: ["auto", "claude-opus-4-7", "gpt-5.5"],
  modelLabels: { auto: "Auto-Combo" },
});

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

Para uma mesclagem não destrutiva com um arquivo existente, replique mergeOpenCodeConfigText() de opencodeConfig.ts ou chame o gerador via CLI.

Consulte o README do pacote para ver a API completa.


O que o runtime realmente faz

Ambos os caminhos produzem o mesmo provider.omniroute.npm: "@ai-sdk/openai-compatible". Durante a execução, o OpenCode carrega @ai-sdk/openai-compatible (que já é uma dependência transitiva do OpenCode) e o configura com baseURL + apiKey. A partir daí:

UI/agente do OpenCode
   → @ai-sdk/openai-compatible
      → HTTP POST {baseURL}/chat/completions          (interface OpenAI do OmniRoute)
         → manipulador /v1/chat/completions do OmniRoute     (open-sse/handlers/chatCore.ts)
            → roteamento combinado / Auto-Combo / executor
               → provedor upstream

O plugin nunca interage diretamente com HTTP. Ele apenas gera a configuração.


Padrões do catálogo de modelos

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;

Você pode substituir esses valores usando models: [...]. Adições recomendadas:

  • "auto" — disponibiliza o roteador Auto-Combo do OmniRoute, que não exige configuração. Permite que o OpenCode escolha "o melhor modelo disponível" sem que você precise codificar o catálogo diretamente.
  • "<combo-name>" — qualquer combinação que você tenha definido no painel; o OmniRoute a resolve de forma transparente.

Normalização de URL

O auxiliar aceita ambos os formatos e gera exatamente um /v1:

Entrada Saída (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

Essa deduplicação é a causa mais comum de falhas observada em configurações antigas. Se você tiver um opencode.json anterior à v3.8.0 que aponte para /v1/v1/..., execute novamente o gerador ou chame createOmniRouteProvider outra vez.


Modos de autenticação

Configuração do OmniRoute Valor recomendado de apiKey
REQUIRE_API_KEY=false (padrão para ambiente local) sk_omniroute (placeholder literal)
REQUIRE_API_KEY=true Uma chave de API real por usuário obtida em Painel → Chaves de API.

Para clientes no estilo Anthropic que enviam x-api-key + anthropic-version, o extractApiKey do OmniRoute também aceita a chave de x-api-key. O OpenCode usa a interface do OpenAI, portanto sempre enviará Authorization: Bearer ${apiKey} — nenhum caso especial do Anthropic se aplica aqui.


Solução de problemas

Sintoma Causa Correção
404 em todas as solicitações com URL contendo /v1/v1/ Configuração obsoleta de um plugin anterior à v3.8 que adicionava /v1 duas vezes. Gere-a novamente por meio do Caminho 1 ou 2.
401 Invalid API key O OmniRoute está com REQUIRE_API_KEY=true e a chave é desconhecida. Crie a chave no painel ou defina REQUIRE_API_KEY=false (somente em ambiente local) e use sk_omniroute.
Lista de modelos vazia na interface do OpenCode Todos os 4 modelos padrão estão ocultos na visibilidade de provedores do OmniRoute. Passe models: ["auto", ...] para disponibilizar aqueles que você habilitou.
Erro 500 do OpenCode com cannot read property 'models' Versões antigas do OpenCode (< 0.1.x) não aceitavam models inline. Atualize o OpenCode para uma versão compatível com o esquema v1 (opencode.ai/config.json).

Veja também