← 首页
Setup Guide · 安装指南
OpenCode Windows 安装指南
01 · Overview

整体流程

  1. 装 Node.js(OpenCode 的运行依赖)
  2. npm 全局装 OpenCode
  3. 配置公司内网 provider(走代理服务,不直接调外网模型 API)
  4. 启动并验证——一次成功,之后日常使用都不用再碰这些
02 · Node.js

第 1 步:装 Node.js

OpenCode 是 Node.js 应用,需要 Node 18 或以上。团队提供的是免安装的 zip 包 node-v24.15.0-win-x64.zip——解压 + 配 PATH 就能用,不需要管理员权限。

2.1 下载并解压

下载安装包:node-v24.15.0-win-x64.zip(约 35 MB)。

下载完右键 → 解压。把解压出来的整个 node-v24.15.0-win-x64 文件夹移动到一个固定位置,推荐:

C:\nodejs\

移动后这个目录里应该能看到 node.exenpm.cmdnpx.cmd 等文件——这就是装好了。

为什么放在 C:\nodejs\:避免路径里有空格(Program Files 那种带空格的路径偶尔会让 npm 脚本出错),也避免日后路径过深。如果你习惯放在 D:\ 或用户目录下也可以,记住这个路径,下一步要用

2.2 把 Node 加进 PATH

这一步告诉 Windows 在哪能找到 nodenpm 命令。

  1. Win → 搜"环境变量" → 点"编辑账户的环境变量"(不需要管理员权限)
  2. 在上面的"用户变量"里找到 Path,双击
  3. "新建",输入 C:\nodejs(注意:是文件夹路径,不是 node.exe 的路径)
  4. 一路"确定"关闭所有窗口

或者用 PowerShell 一行命令搞定(更快):

[Environment]::SetEnvironmentVariable(
  "Path",
  [Environment]::GetEnvironmentVariable("Path", "User") + ";C:\nodejs",
  "User"
)

2.3 验证版本

关掉所有 PowerShell 窗口(PATH 改了之后必须重开新窗口才生效),重新打开一个,运行:

node --version
npm --version

能看到 v24.15.0 和对应的 npm 版本号就 OK 了。

如果命令找不到:

03 · Install

第 2 步:装 OpenCode

3.1 全局安装

PowerShell 里运行:

npm install -g opencode-ai

等它跑完,最后一行没报红色 ERR 就成。

3.2 验证

opencode --version

能输出版本号说明装好了。如果提示 opencode 不是内部或外部命令

⚠ 已知坑:/bin/sh.exe 报错
Windows 上 npm 自动生成的 opencode.ps1 wrapper 偶尔会报 /bin/sh.exe 找不到。如果遇到,最简单的解法是装 Git for Windowsgit-scm.com),它自带 sh.exe,并把 C:\Program Files\Git\bin 加进 PATH 就能解决。

3.3 升级与卸载

# 升级
npm update -g opencode-ai

# 卸载
npm uninstall -g opencode-ai

3.4 可选路径:桌面版(Beta)

⚠ 当前为 Beta:桌面版处于公开测试阶段,行为可能跟 CLI 版本有出入——部分 skill / plugin 触发不一致、配置文件路径偶尔会变。推荐路径仍是 npm 装的 CLI 版,桌面版只作为下面这两类场景的备选方案。

适合谁

需要走完整工程流程(skill、AGENTS.md、自动化)的话,仍然走前面的 npm 路径——本文档其余章节也都按 CLI 版来写。

怎么装

  1. 下载安装包:OpenCode Desktop Installer.exe(约 113 MB)
  2. 双击 .exe 文件,跟着向导一路 Next 装完——首次运行 Windows SmartScreen 可能拦截,点"更多信息"→"仍要运行"
  3. 在开始菜单 / 桌面找到 OpenCode 图标,双击启动——出来的是 GUI 窗口而不是 TUI 终端

装完之后

桌面版的配置文件路径跟 CLI 版一致%USERPROFILE%\.config\opencode\opencode.json),所以第 4 章的 sub2api provider 配置直接复用。验证步骤参考第 5 章——只是界面变成了 GUI,/model/init 这些命令通过菜单或输入框触发。

遇到问题先回 CLI 版:桌面版作为 Beta 偶尔会卡在启动、找不到 provider、或 skill 不触发。这种情况优先卸了换 npm 路径,不要花太多时间排查桌面版的 bug——它还在快速迭代中。
04 · Provider

第 3 步:配置内网 Provider

公司要求所有模型调用必须走内网代理服务,不能直接连 Anthropic / OpenAI 公网 API。这一步配置完,OpenCode 就会把所有请求转到内网网关。

开始前的准备:先登录 sub2api 控制台自助创建一个 API Key,复制下来备用——下面 4.2 步会用到。Key 的样子是 sk- 开头的一长串字符,不需要找谁审批,自己点两下按钮就有。

4.1 创建配置文件

OpenCode 在 Windows 上读取的全局配置路径是:

%USERPROFILE%\.config\opencode\opencode.json

等价于:C:\Users\<你的用户名>\.config\opencode\opencode.json

用 PowerShell 一键创建目录并打开:

New-Item -ItemType Directory -Force "$env:USERPROFILE\.config\opencode" | Out-Null
notepad "$env:USERPROFILE\.config\opencode\opencode.json"

Notepad 提示文件不存在时点"是"创建。

4.2 粘贴配置内容

把下面的 JSON 完整粘贴进去,apiKey 替换成你自己在 sub2api 控制台创建的真实 key

{
  "$schema": "https://opencode.ai/config.json",
  "provider": {
    "sub2api": {
      "npm": "@ai-sdk/anthropic",
      "options": {
        "baseURL": "http://172.168.128.172:8080/v1",
        "apiKey": "sk-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
      },
      "models": {
        "kimi-for-coding": {
          "name": "K2.6"
        }
      }
    }
  }
}

保存关闭。

⚠ API Key 保密
Key 是公司账号的凭证,不要:贴到群里、提交到 git、发给同事、放到代码注释里。如果不小心泄露,立刻回 sub2api 控制台撤销旧 key 并重新创建。
建议直接把 opencode.json 加进系统级 .gitignore_global,避免误提交。

4.3 配置项逐字段说明

字段含义
provider.sub2api 自定义 provider 名 给这个内网代理起的别名,后面 OpenCode 内部用它来引用。这个名字可以自己改,但建议跟团队约定保持一致,方便互相对照配置
npm @ai-sdk/anthropic 使用 Anthropic 兼容的 SDK——内网网关对外暴露的是 Anthropic 协议,所以这里固定填这个
options.baseURL http://172.168.128.172:8080/v1 公司内网代理服务地址。必须在公司网络 / VPN 下才能访问
options.apiKey sk-... 个人凭证,登录 sub2api 控制台自助创建,复制粘贴到这里即可
models.kimi-for-coding 模型 ID 内网网关后端实际路由到的模型 ID,由平台后端定义。不要改
models.kimi-for-coding.name K2.6 OpenCode TUI 里显示的友好名称。可以改成你喜欢的,比如 "内部模型 v2.6"

4.4 项目级覆盖(可选)

如果某个项目要用不同的模型 / 配置,在项目根目录放一份 opencode.json,OpenCode 会优先读项目级、再 fallback 到全局级。常见场景:

项目级配置示例(只覆盖需要的字段):

{
  "$schema": "https://opencode.ai/config.json",
  "permission": "allow"
}
05 · First Run

第 4 步:启动并验证

5.1 启动

找个空目录(避免在重要项目上做第一次测试),打开 PowerShell:

mkdir hello-opencode
cd hello-opencode
opencode

第一次启动会进入 TUI 主界面。

5.2 确认模型已加载

进入 OpenCode 后输入:

/model

能在列表里看到 K2.6(你在 opencode.json 里给它起的友好名)就说明 provider 配置生效了。选中它。

如果看不到 K2.6 / 报错"无可用模型"——参考第 6 章的排查清单。

5.3 跑一个 hello world 任务

在输入框敲:

创建一个 README.md,写一段简短的项目介绍,主题随便编。

预期看到:

  1. 它先输出一段 plan / 复述需求
  2. 调用 write 工具写文件——会停下来让你确认
  3. 确认后写入 README.md
  4. 报告完成

看到这一连串就说明从安装到模型到工具调用整条链路都通了。退出:/exit

完成后你拥有
一个能用公司内网模型、能读写本地文件、能跑命令的 OpenCode 环境。下一步去看《AI 编程分享》文档,了解日常怎么把它用好。
06 · Troubleshooting

常见问题排查

6.1 opencode 命令找不到

6.2 /model 看不到 K2.6

6.3 网络报错 / 连接超时

6.4 401 / 403 鉴权失败

6.5 终端字符乱码 / 渲染错位

原生 cmd / 老 PowerShell 控制台对 TUI 支持不全。换成 Windows Terminal(Microsoft Store 免费):

winget install Microsoft.WindowsTerminal

6.6 /bin/sh.exe 找不到

npm 在 Windows 上的已知问题。解法:装 Git for Windowsgit-scm.com),它自带 sh.exe 并能被 OpenCode 找到。

6.7 还卡住?

找团队 OpenCode 群求助时,附上:

这 4 项齐全的话定位会很快。

07 · Quick Reference

命令速查

安装相关

# 装 Node.js
# → 解压团队提供的 node-v24.15.0-win-x64.zip 到 C:\nodejs\
# → 把 C:\nodejs 加进用户 PATH,重开 PowerShell

# 装 OpenCode
npm install -g opencode-ai

# 升级 OpenCode
npm update -g opencode-ai

# 卸载 OpenCode
npm uninstall -g opencode-ai

# 验证
node --version
opencode --version

关键路径

用途Windows 路径
全局配置%USERPROFILE%\.config\opencode\opencode.json
全局 skill 目录%USERPROFILE%\.config\opencode\skills\
npm 全局安装目录%APPDATA%\npm(用 npm config get prefix 查)
项目级配置项目根目录 opencode.json

OpenCode 内置命令

命令作用
/model切换模型,确认 K2.6 是否可用
/init给当前项目生成 AGENTS.md 草稿
/new清空对话上下文,开新一段
/help看完整命令列表
/exit退出

最小可用配置(脱敏版)

{
  "$schema": "https://opencode.ai/config.json",
  "provider": {
    "sub2api": {
      "npm": "@ai-sdk/anthropic",
      "options": {
        "baseURL": "http://172.168.128.172:8080/v1",
        "apiKey": "sk-XXXX...XXXX"
      },
      "models": {
        "kimi-for-coding": {
          "name": "K2.6"
        }
      }
    }
  }
}

apiKey 字段在本指南中已脱敏处理,使用时请去 sub2api 控制台自助创建真实 key 并替换。