> ## Documentation Index
> Fetch the complete documentation index at: https://docs.viviai.cc/llms.txt
> Use this file to discover all available pages before exploring further.

# OpenCode

> OpenCode 接入 ViVi-API 的配置教程。

准备好 [ViVi-API 控制台](https://api.viviai.cc/dashboard)创建的令牌 Key，并确认分组支持所选模型。已有配置请先备份，再合并所需字段。

## 1. 选择配置文件位置

最容易确认的方式：在当前项目根目录创建 **`opencode.jsonc`**。JSONC 支持注释，便于维护。

全局配置默认使用 `~/.config/opencode/opencode.jsonc`；Windows 中 `~` 表示当前用户主目录。使用自定义配置目录时，以客户端实际加载的位置为准，不要直接假定它位于 `%APPDATA%`。

先执行 `opencode --version` 确认版本。新版使用 `providers / package / settings`，旧版使用 `provider / npm / options`，两套格式不要混用。

## 2. 设置密钥环境变量

> [tab] Windows PowerShell
>
> ```powershell theme={null}
> $env:VIVI_API_KEY = "sk-your-api-key"
> ```

> [tab] macOS / Linux
>
> ```bash theme={null}
> export VIVI_API_KEY="sk-your-api-key"
> ```

以下示例使用 **Anthropic Messages 协议与 Claude 模型**。将模型 ID 替换为令牌实际支持的 Claude 模型。

## 3. 配置供应商

> [tab] 新版 V2
>
> ```json opencode.jsonc theme={null}
> {
>   "$schema": "https://opencode.ai/config.json",
>   "model": "viviapi/claude-sonnet-4-6",
>   "providers": {
>     "viviapi": {
>       "name": "ViVi-API",
>       "package": "@opencode/ai/providers/anthropic-compatible",
>       "settings": {
>         "baseURL": "https://api.viviai.cc/v1",
>         "apiKey": "{env:VIVI_API_KEY}"
>       },
>       "models": {
>         "claude-sonnet-4-6": { "name": "Claude Sonnet 4.6" },
>         "claude-opus-4-6": { "name": "Claude Opus 4.6" }
>       }
>     }
>   }
> }
> ```

> [tab] 旧版 V1
>
> ```json opencode.jsonc theme={null}
> {
>   "$schema": "https://opencode.ai/config.json",
>   "model": "viviapi/claude-sonnet-4-6",
>   "provider": {
>     "viviapi": {
>       "name": "ViVi-API",
>       "npm": "@ai-sdk/anthropic",
>       "options": {
>         "baseURL": "https://api.viviai.cc/v1",
>         "apiKey": "{env:VIVI_API_KEY}"
>       },
>       "models": {
>         "claude-sonnet-4-6": { "name": "Claude Sonnet 4.6" },
>         "claude-opus-4-6": { "name": "Claude Opus 4.6" }
>       }
>     }
>   }
> }
> ```

> [!NOTE]
>
> `{env:VIVI_API_KEY}` 会读取启动 OpenCode 的进程环境变量。若使用 Gemini 或 OpenAI 兼容协议，需要同时更换供应商适配器、请求地址和模型列表，不能只把 Anthropic 示例中的模型名换成 Gemini。

## 4. 重启并选择模型

1. 关闭旧会话；若刚保存了用户级环境变量，打开新终端。若只在当前终端设置变量，就从该终端启动。
2. 在项目目录运行 `opencode`。
3. 在输入框输入 `/models`，搜索 `viviapi` 或 `ViVi-API`。
4. 选择对应模型，发送简短消息测试。

版本变更请参考 [OpenCode 配置文档](https://opencode.ai/docs/config/)和[供应商文档](https://opencode.ai/docs/providers/)。

更多说明见[接入概览](https://docs.viviai.cc/scenarios.md)与[常见问题](https://docs.viviai.cc/faq.md)。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.