English
Integration docs

BitCloud API Documentation

Browse Base URL, API key, model, and client setup guides for connecting tools to the unified gateway.

Current documentOpenCode
Markdown rendered as page contentOpenCode

OpenCode 配置

BitCloud API 兼容 OpenAI 协议,支持 OpenCode CLI 和 IDE 插件,可参考本文进行配置与使用。


前置工作

获取凭证

项目
BASE_URL(OpenAI 兼容协议)https://web.bitcloud.com.cn/v1
API Key格式:sk-xxxxx
获取方式前往 控制台 → 令牌管理 页面创建

使用 OpenCode CLI

安装 OpenCode CLI

OpenCode 支持两种安装方式。

方式一:官方脚本安装(适用于 macOS/Linux)

bashcurl -fsSL https://opencode.ai/install | bash

方式二:npm 安装

需先安装 Node.js 18 或更新版本。

bashnpm install -g opencode-ai

验证安装(如有版本号输出,则表示安装成功):

bashopencode -v

配置基本信息

编辑或新建 opencode.json 配置文件,具体路径如下:

  • macOS/Linux~/.config/opencode/opencode.json
  • Windows用户目录\.config\opencode\opencode.json

将以下内容完整复制到配置文件中(实际使用时按需更换 BASE_URLAPI_KEY):

json{
  "$schema": "https://opencode.ai/config.json",
  "provider": {
    "bitcloud": {
      "npm": "@ai-sdk/openai-compatible",
      "name": "BitCloud",
      "options": {
        "baseURL": "BASE_URL",
        "apiKey": "API_KEY"
      },
      "models": {
        "gpt-4o": {
          "name": "GPT-4o",
          "limit": {
            "context": 128000,
            "output": 16384
          },
          "modalities": {
            "input": ["text", "image"],
            "output": ["text"]
          }
        },
        "claude-sonnet-4-20250514": {
          "name": "Claude Sonnet 4",
          "limit": {
            "context": 200000,
            "output": 8192
          },
          "modalities": {
            "input": ["text", "image"],
            "output": ["text"]
          }
        }
      }
    }
  }
}

注意事项: 如果需要开启图片理解能力,需要在支持该能力的模型的配置节点下修改或新增如下配置项,即在支持的输入模态中增加 image

json"modalities": {"input": ["text", "image"], "output": ["text"]}

使用 OpenCode CLI

以上配置完成后,进入项目目录,执行以下命令启动 OpenCode:

bashopencode

启动以后,输入 /models 可查看和切换使用的模型。


使用 OpenCode IDE 插件

安装插件

在 VS Code 扩展市场搜索并安装 opencode 插件。

配置自定义供应商

可参考 OpenCode CLI 中"配置基本信息"的步骤进行配置。

使用 OpenCode 插件

配置完成后即可在 VS Code 中使用 OpenCode 插件。


常见问题

在 Windows 系统验证安装时,遇到如下报错,如何解决?

"It seems that your package manager failed to install the right version of the opencode CLI for your platform..."

回答: 按照提示执行命令即可解决:

bashnpm install -g opencode-windows-x64

在 Windows 上的 VS Code 中启动 OpenCode 时报错?

"opencode : 无法加载文件 ... 因为在此系统上禁止运行脚本"

回答: 将 VS Code 里打开终端时,默认启动的终端类型改为 Git Bash