前置条件
- 1已安装 Node.js 18+(npm 安装方式)或可运行官方安装脚本
- 2已注册至少一家 LLM 供应商账号(或使用 GitHub Copilot 订阅 / OpenCode Zen)
- 3支持 macOS / Linux / Windows(推荐 WSL2)
腾讯智能体开发平台 ADP
新客首月专属价,最高直降 880 元,构建/分发/治理企业级 Agent
OpenCode 终端 AI 编程工具使用指南
OpenCode 是一款 MIT 协议、模型无关(BYO Model)的开源终端 AI 编程 Agent,形态上对标 Anthropic 的 Claude Code,但可接入 75+ LLM 供应商(Claude、GPT、Gemini、xAI、DeepSeek、Qwen、Ollama 等)。它提供终端 TUI、桌面应用、IDE 扩展多种使用形态,并通过 MCP 协议扩展工具能力。
OpenCode 本身就是「终端工具」,用 opencode 命令启动;本教程聚焦于如何安装它,并接入合适的 AI 模型供应商(默认推荐 OpenCode Zen,也支持 GitHub Copilot 订阅、Anthropic、OpenAI 等任意供应商)。
信息
📌 仓库变迁:原仓库 github.com/sst/opencode 已于 2026 年 1 月正式迁移到 github.com/anomalyco/opencode,由 SST 团队演化的 Anomaly 维护;文档与下载统一在 opencode.ai。
前置准备
1. 获取 LLM 凭据
OpenCode 支持多种认证方式,任选一种:
| 方式 | 凭据来源 | 适合场景 |
|---|---|---|
| OpenCode Zen(推荐新手) | opencode.ai/auth | 官方精选测试模型,开箱即用 |
| GitHub Copilot 订阅 | Pro / Pro+ / Business / Enterprise | 已有 Copilot 订阅的用户 |
| 供应商 API Key | Anthropic / OpenAI / DeepSeek / Google 等 | 自带模型账号的进阶用户 |
| 本地模型 | Ollama / vLLM / LM Studio | 离线、隐私场景 |
警告
⚠️ 凭据保存在 ~/.local/share/opencode/auth.json,请勿提交到公开仓库。
2. 系统要求
| 依赖 | 版本要求 | 说明 |
|---|---|---|
| Node.js | 18+ | npm 安装方式需要 |
| 现代终端 | WezTerm / Alacritty / Ghostty / Kitty / VS Code 集成终端 | TUI 体验最佳 |
支持的系统: macOS、Linux、Windows(推荐 WSL2 获得最佳终端体验)。
分步安装指南
方式一:官方安装脚本(推荐,macOS / Linux / WSL)
1curl -fsSL https://opencode.ai/install | bash脚本自动下载最新版并把 opencode 加入 PATH。
方式二:npm 安装(已有 Node 环境)
1# 注意:npm 包名是 opencode-ai,不是 opencode
2npm install -g opencode-ai
3
4# 升级到最新版
5npm install -g opencode-ai@latest
6
7# 验证安装
8opencode --version中国大陆用户(使用 npm 镜像加速):
1npm config set registry https://registry.npmmirror.com
2npm install -g opencode-ai提示
💡 也可用 Bun / pnpm / Yarn:bun install -g opencode-ai / pnpm install -g opencode-ai / yarn global add opencode-ai。
方式三:Homebrew(macOS / Linux)
1# 推荐:OpenCode tap,更新最快
2brew install anomalyco/tap/opencode
3
4# 或用官方 formula(由 Homebrew 团队维护,更新较慢)
5brew install opencode方式四:Arch Linux
1# 官方仓库稳定版
2sudo pacman -S opencode
3
4# AUR 最新版
5paru -S opencode-bin方式五:Windows 包管理器
1# Chocolatey
2choco install opencode
3
4# Scoop
5scoop install opencode
6
7# Mise
8mise use -g github:anomalyco/opencode方式六:Docker 运行
1docker run -it --rm ghcr.io/anomalyco/opencode方式七:二进制直接下载
从 GitHub Releases 下载对应平台的二进制文件,重命名为 opencode 并放入 PATH 即可。
配置认证与 API Key
方法一:TUI 内 /connect 命令(推荐)
最简单的方式:进入 TUI 后用 /connect 命令交互式添加任意供应商凭据。
1# 启动 TUI
2opencode
3
4# 在 TUI 内执行:
5/connect接入 OpenCode Zen(新手首选):
- 执行
/connect,选择opencode - 浏览器自动打开 opencode.ai/auth,登录并添加账单信息
- 复制 API Key,粘回到 TUI
- 执行
/models浏览官方精选模型列表
接入其他供应商(如 302.AI、Anthropic、OpenAI):
- 执行
/connect,搜索供应商名称 - 输入对应 API Key
- 执行
/models选择模型
凭据保存在 ~/.local/share/opencode/auth.json。
方法二:CLI 登录
1# 交互式登录
2opencode auth login
3
4# 查看已配置的凭证
5opencode auth ls也可在 VS Code 命令面板执行 OpenCode: Auth Login。
方法三:环境变量(适合自动化 / 云厂商)
针对特定供应商可用环境变量。例如接入 Amazon Bedrock:
1# 方式 1:AWS 访问密钥
2AWS_ACCESS_KEY_ID=XXX AWS_SECRET_ACCESS_KEY=YYY opencode
3
4# 方式 2:命名 profile
5AWS_PROFILE=my-profile opencode
6
7# 方式 3:Bedrock bearer token
8AWS_BEARER_TOKEN_BEDROCK=XXX opencode配置文件:opencode.json
OpenCode 支持 JSON 与 JSONC(带注释)格式,配置文件分层加载、合并而非覆盖:
| 层级 | 路径 | 作用 |
|---|---|---|
| 远程 | .well-known/opencode | 组织默认(自动拉取) |
| 全局 | ~/.config/opencode/opencode.json | 用户级 |
| 自定义 | OPENCODE_CONFIG 环境变量 | 用户覆盖 |
| 项目 | opencode.json / opencode.jsonc(项目根) | 项目级覆盖 |
| TUI | ~/.config/opencode/tui.json | TUI 专属(主题、键位等) |
信息
后加载的配置只覆盖冲突的键,非冲突设置全部保留。
opencode.json 示例:
1{
2 "$schema": "https://opencode.ai/config.json",
3 // 主题
4 "theme": "opencode",
5 // 默认模型
6 "model": "anthropic/claude-sonnet-4-5",
7 // 自动更新
8 "autoupdate": true
9}自定义供应商 Base URL
通过 provider.<name>.options.baseURL 接入任意 OpenAI 兼容端点(代理、私有镜像、自建网关):
1{
2 "$schema": "https://opencode.ai/config.json",
3 "provider": {
4 "anthropic": {
5 "options": {
6 "baseURL": "https://api.anthropic.com/v1"
7 }
8 },
9 "amazon-bedrock": {
10 "options": {
11 "region": "us-east-1",
12 "profile": "my-aws-profile"
13 }
14 }
15 }
16}快速开始
1. 进入项目目录
1cd /path/to/your/project2. 启动 TUI
1opencode3. 初始化项目上下文
/init
OpenCode 会分析项目结构并在项目根目录生成 AGENTS.md,把项目规范、技术栈、关键文件说明写入其中。建议提交到 Git,让团队成员共享。
4. 切换 Plan / Build 模式
按 Tab 键在右下角模式指示器处切换:
- Plan 模式:只读分析,给出实施计划,不动任何文件
- Build 模式:开放全部工具,可读写文件、执行命令
5. 模糊搜索文件
用 @ 键触发文件模糊搜索,把文件加入对话上下文:
How is authentication handled in @packages/functions/src/api/index.ts
6. 撤销与重做
1/undo # 撤销上一次改动(可多次)
2/redo # 重做
3/share # 生成对话分享链接并复制到剪贴板核心功能与使用模式
Plan / Build 双模式
| 模式 | 行为 | 适合场景 |
|---|---|---|
| Plan | 只读分析、给出实施计划 | 不熟悉代码库时先评估 |
| Build | 全工具开放、可直接修改 | 方案确认后实施 |
提示
💡 推荐工作流:Plan 模式出方案 → 迭代讨论 → 切 Build 模式实施。
内置工具
| 工具 | 功能 |
|---|---|
| 文件读写 | 读取、编辑、创建项目文件 |
| Shell 执行 | 运行命令并解析输出 |
| 图片识别 | 拖拽图片到终端即可加入提示词 |
| MCP 工具 | 调用自定义 MCP 服务器扩展能力 |
| LSP 集成 | 语言服务器提供符号、诊断 |
| AST 搜索 | ast-grep 结构化代码搜索 |
多供应商与多模型
- 基于 models.dev 注册表,支持 75+ 供应商
- 可在会话中用
/models切换模型 - 不同任务用不同模型,按需优化成本
自定义子代理(Subagents)
可在 ~/.config/opencode/agents/ 下定义自定义子代理,组合 MCP 工具完成专项任务(如代码审查、文档生成、前端实现等)。
配置文件与项目上下文
AGENTS.md(项目级规则)
在项目根目录放置 AGENTS.md,OpenCode 会读取作为每次对话的上下文,写入技术栈、编码规范、关键路径说明等。若从 Claude Code 迁移,OpenCode 会回退读取 CLAUDE.md。
.opencode 目录
项目根或 ~/.config/opencode/ 下可放置子目录:
agents/:自定义子代理commands/:自定义斜杠命令modes/:自定义模式plugins/:插件skills/:技能themes/:主题
场景应用示例
场景一:代码库理解
1你:How is authentication handled in @packages/functions/src/api/index.ts
2
3OpenCode 会:
41. 用 @ 模糊搜索定位文件
52. 读取并分析认证逻辑
63. 解释关键函数与数据流场景二:分步实现新功能
1你(Plan 模式):When a user deletes a note, flag it as deleted in the database.
2 Then create a screen showing recently deleted notes.
3
4OpenCode 会:
51. Plan 模式下给出实施步骤,不动代码
62. 你迭代细节,可粘参考图:
7 [Image #1] Take a look at this image and use it as a reference.
83. 切 Build 模式:Sounds good! Go ahead and make the changes.
94. OpenCode 直接修改多个文件场景三:直接修改 / 撤销回滚
1你:Can you refactor the function in @packages/functions/src/api/index.ts?
2
3# 不满意?直接撤销
4/undo
5
6# 调整 prompt 后重试最佳实践
安全建议
- Plan 模式优先评估:陌生代码库先用 Plan 模式了解结构
auth.json加入.gitignore:避免凭据泄露- CI/CD 用环境变量:通过
AWS_PROFILE等环境变量注入最小权限 - 提交
AGENTS.md到 Git:让团队共享项目规则
性能优化
@精准引用文件:只加必要文件,减少 Token 消耗- 用 Plan 模式迭代方案:避免 Build 模式跑偏后浪费 Token
- 多供应商分流:本地模型走 Ollama,复杂推理走 Claude
- 用 OpenCode Zen 入门:官方精选模型开箱即用
故障排查
| 问题 | 解决方案 |
|---|---|
opencode 命令找不到 | 确认 PATH 包含 npm 全局 bin 目录;Windows 用户运行 OpenCode: Install CLI |
/connect 后仍 0 凭证 | 检查 ~/.local/share/opencode/auth.json 写入权限 |
| 401 Unauthorized | Key 过期 / 含空格,重新复制并去除首尾空格 |
| Volta 安装后命令失效 | Volta 与 OpenCode 的符号链接冲突,改用 Homebrew 或官方脚本安装 |
| 配置不生效 | 配置合并机制下,项目配置只覆盖冲突键;检查 JSON 语法 |
| Windows 原生 TUI 异常 | 改用 WSL2,或用桌面应用 / VS Code 扩展替代 |
1# 检查已配置的凭证
2opencode auth ls
3
4# 查看当前生效的配置
5opencode debug config扩展与进阶
官方资源
- 🌐 官网:opencode.ai
- 📖 官方文档:opencode.ai/docs
- 💻 GitHub 仓库:github.com/anomalyco/opencode(原 sst/opencode)
- 📦 npm 包:
opencode-ai - 🔐 认证入口:opencode.ai/auth
- 💬 Discord 社区:opencode.ai/discord
进阶玩法
- MCP 服务器:在
opencode.json的mcp字段配置远程或本地 MCP 服务器 - 自定义子代理:在
~/.config/opencode/agents/下定义专项 Agent - 自定义命令:在
~/.config/opencode/commands/下定义斜杠命令 - GitHub Copilot 集成:用现有 Copilot 订阅直接驱动终端 Agent
- LSP 与 ast-grep:开启语言服务器与结构化代码搜索,提升代码理解精度
- 主题与键位:在
tui.json中自定义 TUI 外观与快捷键
总结
OpenCode 把 Claude Code 形态的终端 AI 编程 Agent 完全开源、模型无关化:一套工具壳,接入 75+ LLM 供应商,支持 Plan / Build 双模式,原生 MCP 扩展,并能用 GitHub Copilot 订阅直接认证。
无论是代码理解、分步实现新功能,还是直接修改与回滚,OpenCode 都能成为你终端里的得力开源 AI 编程 Agent。立即安装,把任意模型接入你的命令行工作流吧!
常见问题
QOpenCode 和 Claude Code 有什么区别?
Claude Code 是 Anthropic 闭源的终端 Agent,只能接 Anthropic 模型;OpenCode 是 MIT 开源、模型无关的同类工具,支持 75+ 供应商,并可由 GitHub Copilot 订阅直接认证。
Qnpm 包名是 opencode 还是 opencode-ai?
npm 包名是 **opencode-ai**,不是 opencode。安装命令为 `npm install -g opencode-ai`,但启动命令仍是 `opencode`。
QGitHub 仓库到底在哪?
原仓库为 `github.com/sst/opencode`,2026 年 1 月已正式迁移到 `github.com/anomalyco/opencode`(由 SST 团队演化的 Anomaly 维护),文档与下载均指向 opencode.ai。
Q能用 GitHub Copilot 订阅认证吗?
可以。2026-01-16 起,Pro/Pro+/Business/Enterprise 的 Copilot 订阅可通过设备码流程直接认证 OpenCode,无需额外账号。
Q怎么接入自定义模型供应商?
在 TUI 内执行 `/connect` 选择供应商并粘贴 API Key;或在 `opencode.json` 的 `provider.<name>.options.baseURL` 中配置自定义端点。凭据保存在 `~/.local/share/opencode/auth.json`。
QPlan 模式和 Build 模式有什么区别?
Plan 模式只读分析、只给出实施计划,不动任何文件;Build 模式开放全部工具,可读写文件、执行命令。用 Tab 键在右下角指示器处切换。