chore: refresh docs and provider ordering (#60731)

This commit is contained in:
Dax
2026-10-30 18:01:11 -04:00
committed by GitHub
Unverified
parent 171dbd6abe
commit 958f965d35
45 changed files with 167 additions and 177 deletions
@@ -2,7 +2,6 @@ export const popularProviders = [
"opencode-go",
"opencode",
"anthropic",
"claude-agent",
"github-copilot",
"openai",
"google",
@@ -37,7 +37,6 @@ import { useIntegrations } from "@/providers/catalog/integrations"
import { ProviderModelGroup, ProviderModelIcon } from "@/providers/models/provider-group"
import type { ModelSelection } from "@/providers/models/selection"
import { decode64 } from "@/runtime/persistence/base64"
import { ExternalLink } from "@/runtime/platform/external-link"
import { SettingsList } from "@/settings/list"
import { useTabs } from "@/shell/tabs/tabs"
import { Persist, persisted } from "@/runtime/persistence/storage"
@@ -270,10 +269,8 @@ export const DialogConnectProvider: Component<{
const CLAUDE_CODE_SETUP_URL = "https://code.claude.com/docs/en/setup"
const CLAUDE_AGENT_DOCS_URL = "https://opencode.ai/v2/docs/providers#claude-agent"
// The TUI's integration groups and order, plus Claude Agent, with connected integrations pulled up into their own group first.
const POPULAR = ["opencode", "opencode-go", "openai", "github-copilot", "anthropic", "claude-agent", "google"]
// The TUI's integration groups and order, with connected integrations pulled up into their own group first.
const POPULAR = ["opencode", "opencode-go", "openai", "github-copilot", "anthropic", "google"]
function ProviderPicker(props: { directory?: string; onSelect: (provider: string) => void; onPrepare?: () => void }) {
const integrations = useIntegrations(() => props.directory)
@@ -1625,10 +1622,7 @@ function ProviderConnection(props: {
data-component="claude-agent-setup"
class="flex flex-col items-start gap-5 px-3 pb-2 text-[13px] font-[440] leading-5 tracking-[-0.04px] text-v2-text-text-muted"
>
<p>
{language.t("provider.connect.claudeAgent.description")}{" "}
<ExternalLink href={CLAUDE_AGENT_DOCS_URL}>{language.t("provider.connect.claudeAgent.learnMore")}</ExternalLink>
</p>
<p>{language.t("provider.connect.claudeAgent.description")}</p>
<Show when={problem()}>
{(message) => (
<div class="flex items-start gap-2 text-v2-text-text-base">
-1
View File
@@ -231,7 +231,6 @@ export const dict = {
"provider.connect.title.anthropicProMax": "Login with Anthropic",
"provider.connect.claudeAgent.description":
"Use your Claude plan or another Claude Code login. Install Claude Code and sign in first.",
"provider.connect.claudeAgent.learnMore": "Learn more",
"provider.connect.claudeAgent.install": "Install Claude Code",
"provider.connect.claudeAgent.signIn.command": "Sign-in command",
"provider.connect.claudeAgent.connect": "Connect",
+1 -1
View File
@@ -112,7 +112,7 @@ export const dict = {
"home.faq.a3.p4.beforeLocal": "ويمكنك أيضًا ربط",
"home.faq.a3.p4.localLink": "النماذج المحلية",
"home.faq.q4": "هل يمكنني استخدام اشتراكاتي الحالية مع OpenCode؟",
"home.faq.a4.p1": "نعم، يمكنك استخدام اشتراكات ChatGPT Plus/Pro أو GitHub Copilot، أو اشتراك Claude عبر Claude Code.",
"home.faq.a4.p1": "نعم، يمكنك استخدام اشتراكات ChatGPT Plus/Pro أو GitHub Copilot.",
"home.faq.q5": "هل يمكنني استخدام OpenCode في الطرفية فقط؟",
"home.faq.a5.beforeDesktop": "ليس بعد الآن! OpenCode متاح الآن كتطبيق لـ",
"home.faq.a5.desktop": "سطح المكتب",
+1 -2
View File
@@ -116,8 +116,7 @@ export const dict = {
"home.faq.a3.p4.beforeLocal": "Você pode até conectar seus",
"home.faq.a3.p4.localLink": "modelos locais",
"home.faq.q4": "Posso usar minhas assinaturas de IA existentes com o OpenCode?",
"home.faq.a4.p1":
"Sim, você pode usar suas assinaturas ChatGPT Plus/Pro ou GitHub Copilot, ou sua assinatura do Claude pelo Claude Code.",
"home.faq.a4.p1": "Sim, você pode usar suas assinaturas ChatGPT Plus/Pro ou GitHub Copilot.",
"home.faq.q5": "Posso usar o OpenCode apenas no terminal?",
"home.faq.a5.beforeDesktop": "Não mais! OpenCode agora está disponível como um app para o seu",
"home.faq.a5.desktop": "desktop",
+1 -2
View File
@@ -115,8 +115,7 @@ export const dict = {
"home.faq.a3.p4.beforeLocal": "Du kan endda forbinde dine",
"home.faq.a3.p4.localLink": "lokale modeller",
"home.faq.q4": "Kan jeg bruge mine eksisterende AI-abonnementer med OpenCode?",
"home.faq.a4.p1":
"Ja, du kan bruge dine ChatGPT Plus/Pro- eller GitHub Copilot-abonnementer eller dit Claude-abonnement via Claude Code.",
"home.faq.a4.p1": "Ja, du kan bruge dine ChatGPT Plus/Pro- eller GitHub Copilot-abonnementer.",
"home.faq.q5": "Kan jeg kun bruge OpenCode i terminalen?",
"home.faq.a5.beforeDesktop": "Ikke længere! OpenCode er nu tilgængelig som en app til",
"home.faq.a5.desktop": "desktop",
+1 -2
View File
@@ -115,8 +115,7 @@ export const dict = {
"home.faq.a3.p4.beforeLocal": "Du kannst sogar deine",
"home.faq.a3.p4.localLink": "lokalen Modelle verbinden",
"home.faq.q4": "Kann ich meine bestehenden AI-Abos mit OpenCode nutzen?",
"home.faq.a4.p1":
"Ja, du kannst deine ChatGPT Plus/Pro- oder GitHub Copilot-Abos sowie dein Claude-Abo über Claude Code nutzen.",
"home.faq.a4.p1": "Ja, du kannst deine ChatGPT Plus/Pro- oder GitHub Copilot-Abos nutzen.",
"home.faq.q5": "Kann ich OpenCode nur im Terminal nutzen?",
"home.faq.a5.beforeDesktop": "Nicht mehr! OpenCode ist jetzt als App für",
"home.faq.a5.desktop": "Desktop",
+1 -2
View File
@@ -115,8 +115,7 @@ export const dict = {
"home.faq.a3.p4.beforeLocal": "You can even connect your",
"home.faq.a3.p4.localLink": "local models",
"home.faq.q4": "Can I use my existing AI subscriptions with OpenCode?",
"home.faq.a4.p1":
"Yes, you can use your ChatGPT Plus/Pro or GitHub Copilot subscriptions, or your Claude subscription through Claude Code.",
"home.faq.a4.p1": "Yes, you can use your ChatGPT Plus/Pro or GitHub Copilot subscriptions.",
"home.faq.q5": "Can I only use OpenCode in the terminal?",
"home.faq.a5.beforeDesktop": "Not anymore! OpenCode is now available as an app for your",
"home.faq.a5.desktop": "desktop",
+1 -2
View File
@@ -116,8 +116,7 @@ export const dict = {
"home.faq.a3.p4.beforeLocal": "Incluso puedes conectar tus",
"home.faq.a3.p4.localLink": "modelos locales",
"home.faq.q4": "¿Puedo usar mis suscripciones de IA existentes con OpenCode?",
"home.faq.a4.p1":
"Sí, puedes usar tus suscripciones de ChatGPT Plus/Pro o GitHub Copilot, o tu suscripción de Claude a través de Claude Code.",
"home.faq.a4.p1": "Sí, puedes usar tus suscripciones de ChatGPT Plus/Pro o GitHub Copilot.",
"home.faq.q5": "¿Solo puedo usar OpenCode en la terminal?",
"home.faq.a5.beforeDesktop": "¡Ya no! OpenCode ahora está disponible como una aplicación para tu",
"home.faq.a5.desktop": "escritorio",
+1 -2
View File
@@ -115,8 +115,7 @@ export const dict = {
"home.faq.a3.p4.beforeLocal": "Vous pouvez même connecter vos",
"home.faq.a3.p4.localLink": "modèles locaux",
"home.faq.q4": "Puis-je utiliser mes abonnements IA existants avec OpenCode ?",
"home.faq.a4.p1":
"Oui, vous pouvez utiliser vos abonnements ChatGPT Plus/Pro ou GitHub Copilot, ou votre abonnement Claude via Claude Code.",
"home.faq.a4.p1": "Oui, vous pouvez utiliser vos abonnements ChatGPT Plus/Pro ou GitHub Copilot.",
"home.faq.q5": "Puis-je utiliser OpenCode uniquement dans le terminal ?",
"home.faq.a5.beforeDesktop": "Plus maintenant ! OpenCode est désormais disponible en application pour",
"home.faq.a5.desktop": "desktop",
+1 -2
View File
@@ -114,8 +114,7 @@ export const dict = {
"home.faq.a3.p4.beforeLocal": "Puoi anche collegare i tuoi",
"home.faq.a3.p4.localLink": "modelli locali",
"home.faq.q4": "Posso usare i miei abbonamenti IA esistenti con OpenCode?",
"home.faq.a4.p1":
"Sì, puoi usare i tuoi abbonamenti ChatGPT Plus/Pro o GitHub Copilot, oppure il tuo abbonamento Claude tramite Claude Code.",
"home.faq.a4.p1": "Sì, puoi usare i tuoi abbonamenti ChatGPT Plus/Pro o GitHub Copilot.",
"home.faq.q5": "Posso usare OpenCode solo nel terminale?",
"home.faq.a5.beforeDesktop": "Non più! OpenCode ora è disponibile come app per",
"home.faq.a5.desktop": "desktop",
+1 -2
View File
@@ -114,8 +114,7 @@ export const dict = {
"home.faq.a3.p4.beforeLocal": "さらに、",
"home.faq.a3.p4.localLink": "ローカルモデル",
"home.faq.q4": "既存のAIサブスクリプションをOpenCodeで使えますか?",
"home.faq.a4.p1":
"はい、ChatGPT Plus/ProまたはGitHub Copilotのサブスクリプション、またはClaude Code経由でClaudeのサブスクリプションを利用できます。",
"home.faq.a4.p1": "はい、ChatGPT Plus/ProまたはGitHub Copilotのサブスクリプションを利用できます。",
"home.faq.q5": "ターミナルだけで使えますか?",
"home.faq.a5.beforeDesktop": "もう違います!OpenCodeは今は",
"home.faq.a5.desktop": "デスクトップ",
+1 -2
View File
@@ -113,8 +113,7 @@ export const dict = {
"home.faq.a3.p4.beforeLocal": "또한",
"home.faq.a3.p4.localLink": "로컬 모델",
"home.faq.q4": "기존 AI 구독을 OpenCode에서 사용할 수 있나요?",
"home.faq.a4.p1":
"네, ChatGPT Plus/Pro 또는 GitHub Copilot 구독을 사용할 수 있으며, Claude Code를 통해 Claude 구독도 사용할 수 있습니다.",
"home.faq.a4.p1": "네, ChatGPT Plus/Pro 또는 GitHub Copilot 구독을 사용할 수 있습니다.",
"home.faq.q5": "OpenCode는 터미널에서만 사용할 수 있나요?",
"home.faq.a5.beforeDesktop": "이제 아닙니다! OpenCode는 이제",
"home.faq.a5.desktop": "데스크톱",
+1 -2
View File
@@ -115,8 +115,7 @@ export const dict = {
"home.faq.a3.p4.beforeLocal": "Du kan til og med koble til dine",
"home.faq.a3.p4.localLink": "lokale modeller",
"home.faq.q4": "Kan jeg bruke mine eksisterende AI-abonnementer med OpenCode?",
"home.faq.a4.p1":
"Ja, du kan bruke ChatGPT Plus/Pro- eller GitHub Copilot-abonnementene dine, eller Claude-abonnementet ditt via Claude Code.",
"home.faq.a4.p1": "Ja, du kan bruke ChatGPT Plus/Pro- eller GitHub Copilot-abonnementene dine.",
"home.faq.q5": "Kan jeg bare bruke OpenCode i terminalen?",
"home.faq.a5.beforeDesktop": "Ikke lenger! OpenCode er nå tilgjengelig som en app for",
"home.faq.a5.desktop": "desktop",
+1 -2
View File
@@ -114,8 +114,7 @@ export const dict = {
"home.faq.a3.p4.beforeLocal": "Możesz nawet podłączyć swoje",
"home.faq.a3.p4.localLink": "lokalne modele",
"home.faq.q4": "Czy mogę używać moich istniejących subskrypcji AI z OpenCode?",
"home.faq.a4.p1":
"Tak, możesz używać swoich subskrypcji ChatGPT Plus/Pro lub GitHub Copilot albo subskrypcji Claude przez Claude Code.",
"home.faq.a4.p1": "Tak, możesz używać swoich subskrypcji ChatGPT Plus/Pro lub GitHub Copilot.",
"home.faq.q5": "Czy mogę używać OpenCode tylko w terminalu?",
"home.faq.a5.beforeDesktop": "Już nie! OpenCode jest teraz dostępny jako aplikacja na",
"home.faq.a5.desktop": "pulpit (desktop)",
+1 -2
View File
@@ -116,8 +116,7 @@ export const dict = {
"home.faq.a3.p4.beforeLocal": "Вы даже можете подключить ваши",
"home.faq.a3.p4.localLink": "локальные модели",
"home.faq.q4": "Могу ли я использовать мои существующие AI-подписки с OpenCode?",
"home.faq.a4.p1":
"Да, вы можете использовать ваши подписки ChatGPT Plus/Pro или GitHub Copilot, а также подписку Claude через Claude Code.",
"home.faq.a4.p1": "Да, вы можете использовать ваши подписки ChatGPT Plus/Pro или GitHub Copilot.",
"home.faq.q5": "Можно ли использовать OpenCode только в терминале?",
"home.faq.a5.beforeDesktop": "Больше нет! OpenCode теперь доступен как приложение для",
"home.faq.a5.desktop": "десктопа",
+1 -2
View File
@@ -112,8 +112,7 @@ export const dict = {
"home.faq.a3.p4.beforeLocal": "คุณยังสามารถเชื่อมต่อกับ",
"home.faq.a3.p4.localLink": "โมเดล Local ของคุณ",
"home.faq.q4": "ฉันสามารถใช้การสมัครสมาชิก AI ที่มีอยู่กับ OpenCode ได้หรือไม่?",
"home.faq.a4.p1":
"ได้ คุณสามารถใช้การสมัครสมาชิก ChatGPT Plus/Pro หรือ GitHub Copilot ของคุณได้ รวมถึงการสมัครสมาชิก Claude ผ่าน Claude Code",
"home.faq.a4.p1": "ได้ คุณสามารถใช้การสมัครสมาชิก ChatGPT Plus/Pro หรือ GitHub Copilot ของคุณได้",
"home.faq.q5": "ฉันใช้ OpenCode ได้เฉพาะในเทอร์มินัลใช่หรือไม่?",
"home.faq.a5.beforeDesktop": "ไม่อีกต่อไป! OpenCode มีแอปสำหรับ",
"home.faq.a5.desktop": "เดสก์ท็อป",
+1 -2
View File
@@ -113,8 +113,7 @@ export const dict = {
"home.faq.a3.p4.beforeLocal": "Hatta",
"home.faq.a3.p4.localLink": "yerel modellerinizi bağlayabilirsiniz",
"home.faq.q4": "Mevcut AI aboneliklerimi OpenCode ile kullanabilir miyim?",
"home.faq.a4.p1":
"Evet, ChatGPT Plus/Pro veya GitHub Copilot aboneliklerinizi ya da Claude Code üzerinden Claude aboneliğinizi kullanabilirsiniz.",
"home.faq.a4.p1": "Evet, ChatGPT Plus/Pro veya GitHub Copilot aboneliklerinizi kullanabilirsiniz.",
"home.faq.q5": "OpenCode'u sadece terminalde mi kullanabilirim?",
"home.faq.a5.beforeDesktop": "Artık hayır! OpenCode artık sizin bu cihazlarınıza",
"home.faq.a5.desktop": "masaüstü",
+1 -2
View File
@@ -114,8 +114,7 @@ export const dict = {
"home.faq.a3.p4.beforeLocal": "Ви навіть можете підключити свої",
"home.faq.a3.p4.localLink": "локальні моделі",
"home.faq.q4": "Чи можу я використовувати свої наявні AI-підписки з OpenCode?",
"home.faq.a4.p1":
"Так, ви можете використовувати підписки ChatGPT Plus/Pro або GitHub Copilot, а також підписку Claude через Claude Code.",
"home.faq.a4.p1": "Так, ви можете використовувати підписки ChatGPT Plus/Pro або GitHub Copilot.",
"home.faq.q5": "Чи можна використовувати OpenCode лише в терміналі?",
"home.faq.a5.beforeDesktop": "Вже ні! OpenCode тепер доступний як застосунок для",
"home.faq.a5.desktop": "десктопа",
+1 -2
View File
@@ -110,8 +110,7 @@ export const dict = {
"home.faq.a3.p4.beforeLocal": "您甚至可以连接您的",
"home.faq.a3.p4.localLink": "本地模型",
"home.faq.q4": "我可以使用现有的 AI 订阅吗?",
"home.faq.a4.p1":
"可以,您可以使用您的 ChatGPT Plus/Pro 或 GitHub Copilot 订阅,也可以通过 Claude Code 使用您的 Claude 订阅。",
"home.faq.a4.p1": "可以,您可以使用您的 ChatGPT Plus/Pro 或 GitHub Copilot 订阅。",
"home.faq.q5": "OpenCode 只能在终端使用吗?",
"home.faq.a5.beforeDesktop": "不再是了!OpenCode 现在也提供",
"home.faq.a5.desktop": "桌面端应用",
+1 -2
View File
@@ -111,8 +111,7 @@ export const dict = {
"home.faq.a3.p4.beforeLocal": "你還可以連接你的",
"home.faq.a3.p4.localLink": "本地模型",
"home.faq.q4": "可以使用我現有的 AI 訂閱嗎?",
"home.faq.a4.p1":
"可以,你可以使用 ChatGPT Plus/Pro 或 GitHub Copilot 訂閱,也可以透過 Claude Code 使用 Claude 訂閱。",
"home.faq.a4.p1": "可以,你可以使用 ChatGPT Plus/Pro 或 GitHub Copilot 訂閱。",
"home.faq.q5": "OpenCode 只能在終端中使用嗎?",
"home.faq.a5.beforeDesktop": "不再是了!OpenCode 現在也提供",
"home.faq.a5.desktop": "桌面端",
+1
View File
@@ -11,6 +11,7 @@ export const collections = {
schema: z.object({
title: z.string(),
description: z.string().optional(),
noindex: z.boolean().optional(),
tableOfContents: z
.union([
z.boolean(),
@@ -22,6 +22,7 @@ const rendered = await render(entry)
currentSlug={entry.id}
headings={rendered.headings}
showTableOfContents={entry.data.tableOfContents !== false}
noindex={entry.data.noindex}
>
<rendered.Content components={{ Callout, Card, CardGroup, CodeBlock, CodeTabs, PlanTabs }} />
</DocsLayout>
+1 -1
View File
@@ -130,7 +130,7 @@ Subagents run with fresh context in foreground or background child sessions. The
}
```
## Builtins
## Built-ins
OpenCode includes these visible agents:
@@ -0,0 +1,101 @@
---
title: "Claude Agent"
noindex: true
---
Use your Claude plan or another Claude Code login. Claude Agent runs Claude Code on your machine, so install Claude Code
2.1.248 or later and sign in first.
```bash
claude auth login
```
Then connect **Claude Agent** and choose a model. The model list comes from Claude Code. Effort levels are variants, such
as `claude-agent/opus#high`.
```text
/connect
# Select Claude Agent.
/models
```
You can also connect from the CLI with `auth login claude-agent`.
OpenCode finds `claude` on your `PATH`. To use another copy, set `OPENCODE_CLAUDE_PATH` on the server.
```bash
opencode service set env OPENCODE_CLAUDE_PATH /opt/claude/bin/claude
```
## How it works
Claude Code calls the model, and OpenCode does everything else.
- Claude gets Claude Code's system prompt, plus your agent's prompt, `AGENTS.md` files, skills, and MCP instructions.
- Claude uses OpenCode's tools and permissions instead of Claude Code's built-in tools.
- Your Claude Code settings, `CLAUDE.md` files, hooks, MCP servers, skills, and memory are not loaded.
- OpenCode runs compaction and subagents.
- You can switch between Claude Agent and other models in the same session.
## Cost
Cost depends on how Claude Code is signed in.
| Login | Cost shown |
| --- | --- |
| Claude subscription | None, your plan covers it |
| Anthropic API key, or Claude Platform on AWS or Google Cloud | Anthropic prices |
| Amazon Bedrock | Bedrock prices, or Anthropic prices on Bedrock Mantle |
| Google Vertex | Vertex prices |
| Microsoft Foundry | Azure prices |
| Custom base URL | None |
## Configure
Connection settings on the `claude-agent` provider are passed to Claude Code. They override the same variables set in
your shell.
```jsonc title="opencode.jsonc"
{
"$schema": "https://opencode.ai/config.json",
"providers": {
"claude-agent": {
"settings": {
"baseURL": "https://llm-proxy.example.com/anthropic",
},
"headers": {
"X-Gateway-Tenant": "engineering",
},
},
},
}
```
| Config | Claude Code variable |
| --- | --- |
| `settings.baseURL` | `ANTHROPIC_BASE_URL` |
| `settings.apiKey` | `ANTHROPIC_API_KEY` |
| `settings.authToken` | `ANTHROPIC_AUTH_TOKEN` |
| `settings.headerTimeout` | `API_TIMEOUT_MS` |
| `settings.chunkTimeout` | `CLAUDE_STREAM_IDLE_TIMEOUT_MS` |
| `headers` | `ANTHROPIC_CUSTOM_HEADERS` |
| `body` | `CLAUDE_CODE_EXTRA_BODY` |
Set them on a model to override the provider's values for that model.
## Limitations
- Claude Code must be installed on the same machine as the OpenCode server. Claude Agent is not available in remote
workspaces.
- Claude Code's system prompt replaces OpenCode's built-in prompt. Custom agent prompts still apply.
- Temperature, top-p, top-k, seed, and stop sequences are not supported.
- Plugin `http.request` and `http.response` hooks do not run, because Claude Code makes the API calls.
- Claude Code features such as `/usage`, `/loop`, auto mode, and agent teams are not available.
## Errors
| Error or symptom | Check |
| --- | --- |
| `Claude Code is not installed` | Install Claude Code, or set `OPENCODE_CLAUDE_PATH` to its path. |
| `Claude Code is not logged in` | Run `claude auth login`, then connect Claude Agent again. |
| `Claude Code ... is too old` | Run `claude update`. |
@@ -115,7 +115,7 @@ The `app.clear` command works only in [`opencode mini`](/cli). Press `ctrl+l` to
| ----------- | -------- | ---------------- |
| `app.clear` | `ctrl+l` | Clear the screen |
## Diff Viewer
## Diff viewer
Press `d` (`diff.switch_source`) to choose **All**, **Committed**, **Uncommitted**, or **Last turn** (inside a session), or select **Base** to change the comparison branch. Choices are remembered until the TUI exits. Set the initial scope with [`diffs.source` in `cli.json`](/cli/config#diffs).
@@ -155,7 +155,7 @@ The shifted `diff.help` alternatives support terminals that report the Shift mod
The retired `diff.toggle`, `diff.expand`, `diff.expand_all`, `diff.collapse`, and `diff.switch_focus` configuration entries are still accepted, but no longer register shortcuts.
## Appearance And Navigation
## Appearance and navigation
| ID | Default | Description |
| -------------------------- | --------------- | ---------------------------------------- |
@@ -231,7 +231,7 @@ The retired `diff.toggle`, `diff.expand`, `diff.expand_all`, `diff.collapse`, an
| `session.tab.select.9` | `<leader>9,ctrl+9` | Switch to session tab 9 |
| `session.tab.select.10` | `<leader>0,ctrl+0` | Switch to session tab 10 |
## Models And Agents
## Models and agents
| ID | Default | Description |
| ------------------------------ | ----------- | ------------------------------------ |
@@ -253,7 +253,7 @@ The retired `diff.toggle`, `diff.expand`, `diff.expand_all`, `diff.collapse`, an
| `variant.cycle` | `ctrl+t` | Cycle model variants |
| `variant.list` | `none` | List model variants |
## Session Navigation
## Session navigation
| ID | Default | Description |
| ------------------------------- | ---------------------- | --------------------------------- |
@@ -275,7 +275,7 @@ The retired `diff.toggle`, `diff.expand`, `diff.expand_all`, `diff.collapse`, an
| `session.redo` | `<leader>r` | Redo message |
| `session.toggle.thinking` | `none` | Toggle thinking blocks visibility |
## Prompt Commands
## Prompt commands
| ID | Default | Description |
| ----------------------------- | ---------------- | ---------------------- |
@@ -288,7 +288,7 @@ The retired `diff.toggle`, `diff.expand`, `diff.expand_all`, `diff.collapse`, an
| `prompt.stash.pop` | `none` | Pop stashed prompt |
| `prompt.stash.list` | `none` | List stashed prompts |
## Input Editing
## Input editing
| ID | Default | Description |
| ------------------------------- | ----------------------------------------------------------------------------- | --------------------------------------- |
@@ -353,7 +353,7 @@ Select a running command in the **Shell** tab and press **Enter**, or click it,
Use **↑/↓**, **Page Up/Down**, or **Home** to scroll, **End** to follow new output, and **Esc** to return without stopping the command.
The viewer shows recent output and stays open after exit; output redirected to a file is not included.
## Dialogs And Autocomplete
## Dialogs and autocomplete
| ID | Default | Description |
| ------------------------------ | ------------- | ----------------------------------- |
@@ -384,7 +384,7 @@ The viewer shows recent output and stays open after exit; output redirected to a
| `dialog.plugins.update` | `ctrl+u` | Update plugin from plugin dialog |
| `dialog.plugins.check` | `ctrl+r` | Check for plugin updates |
## Terminal And Plugins
## Terminal and plugins
| ID | Default | Description |
| ----------------------- | -------- | -------------------------- |
@@ -99,8 +99,6 @@ Some providers also use their native ambient credential chain instead of an API-
`gcloud auth application-default login` and set `GOOGLE_CLOUD_PROJECT`.
- Azure exposes **Microsoft Entra ID (Azure CLI)** as a connect method when `az` is installed. Run `az login` first, then
select that method in `/connect` or `auth login azure`.
- [Claude Agent](/providers#claude-agent) uses your Claude Code login. Run `claude auth login` first, then select
Claude Agent in `/connect` or run `auth login claude-agent`.
```bash
gcloud auth application-default login
+4 -4
View File
@@ -40,7 +40,7 @@ Use `system` to follow your terminal's appearance, or lock the theme to light or
This maps to the `mode` field inside `theme` in your CLI config. If a custom theme provides only one mode, OpenCode uses that mode when the other is requested.
## Adding a Theme
## Adding a theme
To add a theme you downloaded or received from someone else, copy its JSON file into the global themes directory:
@@ -54,7 +54,7 @@ The filename becomes the theme name. For example, `my-theme.json` appears as `my
OpenCode reads `.json` files only. A theme closer to the current directory replaces a global or parent theme with the same name.
## Using Themes in Plugins
## Using themes in plugins
[TUI plugins](/build/plugins/cli) read resolved colors through `context.theme` and the active mode through `context.themeMode`. Use semantic tokens so your plugin follows the selected theme:
@@ -69,9 +69,9 @@ function Status() {
The public TUI plugin API does not register themes. Add custom theme definitions with JSON files in the directories above.
## Creating a Theme
## Creating a theme
Use our [Theme Tool](https://opencode.ai/theme/) to create or edit themes. This tool makes it easy to understand the structure, change it, and define custom colors. The explanation below is for reference.
Use our [theme tool](https://opencode.ai/theme/) to create or edit themes. This tool makes it easy to understand the structure, change it, and define custom colors. The explanation below is for reference.
A theme separates shared semantic tokens from mode-specific palettes:
+1 -1
View File
@@ -4,7 +4,7 @@ description: "Run OpenCode in the browser."
---
OpenCode ships with a web UI that is served from the same server that powers the
TUI. It's available by default and password protected.
TUI. It's available by default and password-protected.
## Access
+1 -1
View File
@@ -31,7 +31,7 @@ Only `.md` files are discovered. Nested paths become command names with `/` sepa
Review $ARGUMENTS using the team's checklist.
```
Run the nested command as `/team/review src/auth.ts`. The legacy singular directories `command/` are also discovered,
Run the nested command as `/team/review src/auth.ts`. The legacy singular directory `command/` is also discovered,
but use `commands/` for new files.
Add YAML frontmatter when the command needs metadata. The trimmed Markdown body is always the prompt template.
+1 -1
View File
@@ -328,7 +328,7 @@ provider automatically.
}
```
See the [websearch guide](/websearch) for providers, credentials, selection,
See the [web search guide](/websearch) for providers, credentials, selection,
rate limits, and disabling search.
### MCP
@@ -9,7 +9,7 @@ using OpenCode, on your own or as a team.
- [Inference](/console/models) for both proprietary and open source models
- [Providers](/console/providers) for connecting your own provider accounts through the Console gateway
- Usage tracking and [budget](/console/budgets) controls
- Deploy team wide policies to control OpenCode behavior
- Deploy team-wide policies to control OpenCode behavior
- [Web search](/console/websearch)
- [Harnesses](/console/harnesses) for using Console models from Claude Code, Codex, and other agents
- [OpenCode Go, Go Plus, and Go Teams](/console/go), $10, $40, and $20/member monthly subscriptions for open source model access
@@ -1,5 +1,5 @@
---
title: "Directory Sync"
title: "Directory sync"
description: "Add and remove workspace members automatically from Okta, Microsoft Entra ID, or any SCIM 2.0 identity provider."
---
@@ -1,5 +1,5 @@
---
title: "Web Search"
title: "Web search"
description: "Hosted web search for OpenCode through Console."
---
@@ -31,7 +31,7 @@ Find the latest Bun release and summarize the changes with source links.
The hosted provider searches the public web and returns up to eight results. OpenCode uses the results to answer the prompt and cite sources.
See the [Websearch guide](/websearch) to configure permissions or disable the tool.
See the [web search guide](/websearch) to configure permissions or disable the tool.
## Billing
+1 -1
View File
@@ -36,7 +36,7 @@ resets them to the built-ins.
}
```
## Builtins
## Built-ins
OpenCode includes these formatter definitions. Most require the named command
to be available; definitions with extra detection rules list them below.
+2 -2
View File
@@ -73,7 +73,7 @@ directly [in the TUI](/cli/providers) with `/connect`.
See [Providers](/providers) to configure custom providers.
If you'd like easy access to all the best coding models you can try out
If you'd like easy access to the best coding models, you can try out
[OpenCode Console](/console).
You can also try [OpenCode Go](/console/go), a $10/month subscription
@@ -91,6 +91,6 @@ settings](/cli/config).
## Learn
If you are interested in an indepth course on OpenCode Boot.dev has created an excellent [AI Coding with
If you are interested in an in-depth course on OpenCode, Boot.dev has created an excellent [AI Coding with
OpenCode](https://www.boot.dev/courses/learn-ai-coding) course in consultation with our team. All the information in the course is
free to read and watch, though some interactive features may require payment.
+4 -4
View File
@@ -11,8 +11,8 @@ V2 has three intentional breaking changes:
- [Plugins](/build/plugins/migrate-v1) use a new plugin API.
- The [server API and clients](#server-api-and-clients) have new contracts.
- [Terminal client configuration](/cli/config) moves from layered `tui.json(c)` files to one global `cli.json` file (auto
migrated).
- [Terminal client configuration](/cli/config) moves from layered `tui.json(c)` files to one global `cli.json` file
(auto-migrated).
Supported V1 functionality outside those areas is intended to remain compatible with V1. Some fields accepted by the V1
schema never had a V2 equivalent and are intentionally ignored; these are listed under
@@ -29,7 +29,7 @@ compatibility bug rather than an expected migration requirement.
## Install V2
Install the V2 terminal client with the [terminal startup guide](/cli).
Install the V2 terminal client with the [installation instructions](/#cli).
You do not need to rewrite everything before starting V2. A practical migration is:
@@ -61,7 +61,7 @@ V2 reads existing system, global, and project configuration from the same locati
<project>/.opencode/opencode.json(c)
```
V2 reads these same locations. It normalizes supported V1 and native V2 fields in memory without rewriting the source
V2 normalizes supported V1 and native V2 fields in memory without rewriting the source
file. Existing supported V1 configuration is intended to keep working, so you do not need to convert it to try or adopt
V2.
+1 -1
View File
@@ -392,7 +392,7 @@ path prefix:
- Omit `apiKey` when the endpoint does not require bearer authentication.
- Disable discovery with `"plugins": ["-opencode.provider.ollama"]`.
### LMStudio
### LM Studio
With an unauthenticated LM Studio server at `http://127.0.0.1:1234`, select a discovered model with the `lmstudio`
provider ID:
+3 -3
View File
@@ -215,7 +215,7 @@ it was configured.
### Upgrading from `integration.use`
Before OpenCode 2.3.0, `integration.use` covered MCP servers, skills, and plugins
Before OpenCode 2.2.3, `integration.use` covered MCP servers, skills, and plugins
through an `mcp:`, `skill:`, or `plugin:` prefix. Prefixed statements still load and
are converted to `mcp.use`, `skill.use`, or `plugin.use`.
@@ -243,8 +243,8 @@ the old meaning, replace it with:
Exceptions move the same way: `integration.use` `mcp:github` becomes `mcp.use`
`github`, and `skill:team:review` becomes `skill.use` `team:review`.
Clients older than 2.3.0 ignore `integration.connect`, `integration.use` (in its new
meaning), `mcp.use`, `skill.use`, and `plugin.use`, so require 2.3.0 or newer
Clients older than 2.2.3 ignore `integration.connect`, `integration.use` (in its new
meaning), `mcp.use`, `skill.use`, and `plugin.use`, so require 2.2.3 or newer
wherever you rely on them.
## Precedence
@@ -56,95 +56,6 @@ enabled.
}
```
## Claude Agent
Use your Claude plan or another Claude Code login. Claude Agent runs Claude Code on your machine, so install Claude Code
2.1.248 or later and sign in first.
```bash
claude auth login
```
Then connect **Claude Agent** and choose a model. The model list comes from Claude Code. Effort levels are variants, such
as `claude-agent/opus#high`.
```text
/connect
# Select Claude Agent.
/models
```
OpenCode finds `claude` on your `PATH`. To use another copy, set `OPENCODE_CLAUDE_PATH` on the server.
```bash
opencode service set env OPENCODE_CLAUDE_PATH /opt/claude/bin/claude
```
### How it works
Claude Code calls the model, and OpenCode does everything else.
- Claude gets Claude Code's system prompt, plus your agent's prompt, `AGENTS.md` files, skills, and MCP instructions.
- Claude uses OpenCode's tools and permissions instead of Claude Code's built-in tools.
- Your Claude Code settings, `CLAUDE.md` files, hooks, MCP servers, skills, and memory are not loaded.
- OpenCode runs compaction and subagents.
- You can switch between Claude Agent and other models in the same session.
### Cost
Cost depends on how Claude Code is signed in.
| Login | Cost shown |
| --- | --- |
| Claude subscription | None, your plan covers it |
| Anthropic API key, or Claude Platform on AWS or Google Cloud | Anthropic prices |
| Amazon Bedrock | Bedrock prices, or Anthropic prices on Bedrock Mantle |
| Google Vertex | Vertex prices |
| Microsoft Foundry | Azure prices |
| Custom base URL | None |
### Configure
Connection settings on the `claude-agent` provider are passed to Claude Code. They override the same variables set in
your shell.
```jsonc title="opencode.jsonc"
{
"$schema": "https://opencode.ai/config.json",
"providers": {
"claude-agent": {
"settings": {
"baseURL": "https://llm-proxy.example.com/anthropic",
},
"headers": {
"X-Gateway-Tenant": "engineering",
},
},
},
}
```
| Config | Claude Code variable |
| --- | --- |
| `settings.baseURL` | `ANTHROPIC_BASE_URL` |
| `settings.apiKey` | `ANTHROPIC_API_KEY` |
| `settings.authToken` | `ANTHROPIC_AUTH_TOKEN` |
| `settings.headerTimeout` | `API_TIMEOUT_MS` |
| `settings.chunkTimeout` | `CLAUDE_STREAM_IDLE_TIMEOUT_MS` |
| `headers` | `ANTHROPIC_CUSTOM_HEADERS` |
| `body` | `CLAUDE_CODE_EXTRA_BODY` |
Set them on a model to override the provider's values for that model.
### Limitations
- Claude Code must be installed on the same machine as the OpenCode server. Claude Agent is not available in remote
workspaces.
- Claude Code's system prompt replaces OpenCode's built-in prompt. Custom agent prompts still apply.
- Temperature, top-p, top-k, seed, and stop sequences are not supported.
- Plugin `http.request` and `http.response` hooks do not run, because Claude Code makes the API calls.
- Claude Code features such as `/usage`, `/loop`, auto mode, and agent teams are not available.
## Custom
Add a provider when its API is not already in the catalog. This OpenAI-compatible example defines the credential,
@@ -735,9 +646,6 @@ ID before changing packages.
| Bedrock does not appear | Provide a profile or another supported AWS credential-chain input. `AWS_REGION` by itself only selects a region. |
| Ollama has no models | Confirm the server exposes `/api/tags` and `/api/show` at the path derived from `baseURL`, and that `/api/show` reports the `completion` capability. |
| Copilot has no models | Confirm the active OAuth account has Copilot Chat access. A failed model sync is logged as `failed to sync GitHub Copilot models`. |
| `Claude Code is not installed` | Install Claude Code, or set `OPENCODE_CLAUDE_PATH` to its path. |
| `Claude Code is not logged in` | Run `claude auth login`, then connect Claude Agent again. |
| `Claude Code ... is too old` | Run `claude update`. |
V2 rejects the retired provider IDs with a direct replacement. Use `azure/<model>` instead of
`azure-cognitive-services/<model>`, and `google-vertex/<model>` instead of `google-vertex-anthropic/<model>`.
+1 -1
View File
@@ -38,7 +38,7 @@ Use `system` to follow your terminal's appearance, or lock the theme to one mode
If a custom theme provides only one mode, OpenCode uses that mode when the other is requested.
## Builtins
## Built-ins
Select a built-in theme by its name:
+1 -1
View File
@@ -154,7 +154,7 @@ input is a search `query`.
Search the web for the latest Bun release notes.
```
Permission: `websearch` with the query as its resource. See [Websearch](/websearch)
Permission: `websearch` with the query as its resource. See [Web search](/websearch)
for providers, selection, rate limits, and disabling the tool.
## Images
+1 -1
View File
@@ -1,5 +1,5 @@
---
title: "Websearch"
title: "Web search"
---
Ask OpenCode for current information and it can search the web, read the results, and include source links in its response.
@@ -15,6 +15,7 @@ interface Props {
headings: MarkdownHeading[]
showTableOfContents?: boolean
fullWidth?: boolean
noindex?: boolean
}
const section = getDocsSection(Astro.props.currentSlug)
@@ -29,6 +30,7 @@ const canonical = new URL(docsHref(Astro.props.currentSlug), "https://opencode.a
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="description" content={description} />
{Astro.props.noindex && <meta name="robots" content="noindex" />}
<meta name="theme-color" content="#000000" />
<script is:inline>
const applyTheme = () => {
@@ -71,7 +73,11 @@ const canonical = new URL(docsHref(Astro.props.currentSlug), "https://opencode.a
<DocsSidebar groups={section.groups} currentSlug={Astro.props.currentSlug} />
</aside>
<main id="docs-content">
<article class="prose" data-pagefind-body data-pagefind-meta={`title:${Astro.props.title}`}>
<article
class="prose"
data-pagefind-body={Astro.props.noindex ? undefined : ""}
data-pagefind-meta={`title:${Astro.props.title}`}
>
<h1>
{Astro.props.title}
<button type="button" aria-label="Copy page as Markdown" data-copy-markdown data-pagefind-ignore>
+2 -2
View File
@@ -39,7 +39,7 @@ export const docsSections: DocsSection[] = [
{ title: "Commands", slug: "commands" },
{ title: "Plugins", slug: "plugins" },
{ title: "Providers", slug: "providers" },
{ title: "Websearch", slug: "websearch" },
{ title: "Web search", slug: "websearch" },
{ title: "Network", slug: "network" },
{ title: "Snapshots", slug: "snapshots" },
{ title: "Compaction", slug: "compaction" },
@@ -139,7 +139,7 @@ export const docsSections: DocsSection[] = [
{ title: "Intro", slug: "console" },
{ title: "Models", slug: "console/models" },
{ title: "Providers", slug: "console/providers" },
{ title: "Web Search", slug: "console/websearch" },
{ title: "Web search", slug: "console/websearch" },
{ title: "Go", slug: "console/go" },
],
},