介绍
OpenCode 是一个开源 AI 编码助手,帮助您在终端、IDE 或桌面应用中编写代码。 开源地址:https://github.com/opencode-ai/opencode
桌面应用现已推出! OpenCode 桌面应用已在 macOS、Windows 和 Linux 上推出测试版。
快速开始
选择您喜欢的安装方式:
curl -fsSL https://opencode.ai/install | bash
或使用包管理器:
# NPM
npm install -g opencode-ai
# Bun
bun install -g opencode-ai
# Homebrew
brew install anomalyco/tap/opencode
# Arch Linux (paru)
paru -S opencode-bin
基本使用
安装完成后,在项目目录中运行:
cd /path/to/your/project
opencode
首次使用时,运行 /init 命令初始化项目配置。
核心功能
- LSP 支持- 自动为 LLM 加载正确的语言服务器
- 多会话- 在同一项目上并行启动多个助手会话
- 分享链接- 分享会话链接供参考或调试
- Claude Pro- 使用您的 Claude Pro 或 Max 订阅
- ChatGPT Plus/Pro- 使用您的 ChatGPT 订阅
- 75+ 模型- 支持 75+ LLM 提供商
- 任何编辑器- 终端、桌面应用、IDE 扩展
配置
OpenCode 使用 JSONC(带注释的 JSON)配置文件,支持多级配置优先级。
配置文件格式
配置文件使用 JSONC 格式(带注释的 JSON)。文件名为 opencode.json 或 opencode.jsonc。
配置优先级
配置按以下优先级加载(从高到低):
| 优先级 | 位置 | 说明 |
|---|---|---|
| 1 | 自定义路径 | 通过 --config 标志指定 |
| 2 | 项目配置 | .opencode/opencode.json |
| 3 | 全局配置 | ~/.config/opencode/opencode.json |
| 4 | 远程配置 | 从服务器获取的配置 |
配置结构
完整的配置文件结构如下:
{
// TUI 设置
"tui": {
"theme": "opencode"
},
// 服务器设置
"server": {
"port": 8080
},
// 工具设置
"tools": {
"bash": {
"enabled": true
}
},
// 模型设置
"models": {
"default": "anthropic/claude-sonnet-4-20250514",
"big": "anthropic/claude-sonnet-4-20250514",
"fast": "anthropic/claude-3-5-haiku-latest"
},
// 代理设置
"agents": {
"default": "default"
},
// 自定义命令
"commands": {},
// 提供商设置
"providers": {},
// LSP 设置
"lsp": {},
// MCP 服务器
"mcp": {
"servers": {}
},
// 权限
"permissions": {
"auto_approve": []
},
// 快捷键
"keybinds": {},
// 其他
"disabled_providers": [],
"custom_instructions": ""
}
环境变量
配置值支持环境变量替换:
$VAR- 引用环境变量 VAR${VAR}- 同上${VAR:-default}- 如果 VAR 未设置,使用默认值
提供商
OpenCode 支持 75+ LLM 提供商。通过 models.dev 提供统一的模型访问。
主要提供商
Anthropic
Claude 系列模型,包括 Claude 3.5 Sonnet、Claude 3 Opus 等。
ANTHROPIC_API_KEYOpenAI
GPT-4、GPT-4 Turbo、GPT-3.5 Turbo 等模型。
OPENAI_API_KEYGemini 系列模型,包括 Gemini 1.5 Pro、Gemini 1.5 Flash。
GOOGLE_API_KEYAWS Bedrock
通过 AWS 访问多种模型,支持 IAM 认证。
AWS_ACCESS_KEY_IDAzure OpenAI
Microsoft Azure 托管的 OpenAI 模型。
AZURE_OPENAI_API_KEYDeepSeek
DeepSeek Coder 等高性能编码模型。
DEEPSEEK_API_KEYGroq
高速推理,支持 LLaMA、Mixtral 等开源模型。
GROQ_API_KEYOllama
本地运行开源模型,支持 LLaMA、Mistral、CodeLlama 等。
OLLAMA_HOSTMistral
Mistral 系列模型,包括 Mistral Large、Codestral。
MISTRAL_API_KEYCohere
Command 系列模型,适合企业应用。
COHERE_API_KEYTogether AI
访问多种开源模型,高性价比选择。
TOGETHER_API_KEYOpenRouter
统一 API 访问多个提供商的模型。
OPENROUTER_API_KEY配置提供商
在配置文件中设置提供商:
{
"providers": {
"anthropic": {
"apiKey": "$ANTHROPIC_API_KEY"
},
"openai": {
"apiKey": "$OPENAI_API_KEY",
"baseUrl": "https://api.openai.com/v1"
},
"ollama": {
"baseUrl": "http://localhost:11434"
}
}
}
使用 Claude Pro / ChatGPT Plus
OpenCode 支持使用您现有的 AI 订阅账号:
# 使用 Anthropic 账号登录(Claude Pro/Max)
opencode auth login anthropic
# 使用 OpenAI 账号登录(ChatGPT Plus/Pro)
opencode auth login openai
网络
配置代理、SSL 证书和网络相关设置。
代理设置
OpenCode 支持通过环境变量配置 HTTP/HTTPS 代理:
export HTTP_PROXY=http://proxy.example.com:8080
export HTTPS_PROXY=http://proxy.example.com:8080
export NO_PROXY=localhost,127.0.0.1
自定义 CA 证书
对于企业网络,可以配置自定义 CA 证书:
export NODE_EXTRA_CA_CERTS=/path/to/ca-certificates.crt
企业版
OpenCode 企业版为组织提供增强的安全性、合规性和管理功能。
企业功能
- SSO 集成- 支持 SAML、OIDC 单点登录
- 审计日志- 完整的使用审计跟踪
- 集中管理- 统一配置和策略管理
- 私有部署- 支持本地部署
- 优先支持- 专属技术支持通道
如需了解企业版详情,请联系 enterprise@opencode.ai
终端界面 (TUI)
OpenCode TUI 是功能最全面的客户端,提供丰富的终端界面体验。
启动 TUI
cd /path/to/your/project
opencode
文件引用
在对话中引用文件:
@filename- 引用文件@folder/- 引用文件夹@**/*.ts- 使用 glob 模式
Bash 命令
直接运行 bash 命令:
$ command- 运行并返回输出$$ command- 运行并将输出添加到上下文
斜杠命令
| 命令 | 说明 |
|---|---|
/init |
初始化项目配置 |
/clear |
清空当前会话 |
/compact |
压缩对话历史 |
/models |
切换模型 |
/sessions |
管理会话 |
/connect |
连接到远程服务器 |
/share |
分享当前会话 |
/theme |
切换主题 |
/bug |
报告 bug |
/help |
显示帮助 |
/cost |
显示使用成本 |
/context |
管理上下文 |
快捷键
| 快捷键 | 功能 |
|---|---|
| Ctrl+C | 取消当前操作 |
| Ctrl+L | 清屏 |
| Ctrl+J | 换行 |
| Enter | 发送消息 |
| Tab | 自动补全 |
| Esc | 返回/取消 |
命令行 (CLI)
OpenCode CLI 提供强大的命令行工具,支持自动化和脚本集成。
主要命令
| 命令 | 说明 |
|---|---|
opencode |
启动 TUI |
opencode run |
非交互式运行 |
opencode agent |
代理管理 |
opencode auth |
认证管理 |
opencode github |
GitHub 集成 |
opencode mcp |
MCP 服务器管理 |
opencode models |
模型管理 |
opencode serve |
启动服务器 |
opencode session |
会话管理 |
opencode web |
启动 Web 界面 |
常用标志
# 指定配置文件
opencode --config /path/to/config.json
# 指定工作目录
opencode --cwd /path/to/project
# 详细输出
opencode --verbose
# 版本信息
opencode --version
非交互式运行
# 单次执行
opencode run "解释这个代码"
# 从文件读取
opencode run --file prompt.txt
# 指定模型
opencode run --model anthropic/claude-sonnet-4-20250514 "你的问题"
# 管道输入
echo "解释这段代码" | opencode run
环境变量
| 变量 | 说明 |
|---|---|
OPENCODE_CONFIG |
配置文件路径 |
OPENCODE_LOG_LEVEL |
日志级别 |
OPENCODE_DATA_DIR |
数据目录 |
Web 界面
OpenCode 提供基于 Web 的界面,可通过浏览器访问。
启动 Web 界面
# 启动 Web 服务器
opencode web
# 指定端口
opencode web --port 3000
# 指定主机
opencode web --host 0.0.0.0
启动后,在浏览器中访问 http://localhost:3000。
IDE 扩展
OpenCode 提供 VS Code 等 IDE 的扩展,实现无缝集成。
VS Code 扩展
在 VS Code 扩展市场搜索 "OpenCode" 或使用命令:
code --install-extension opencode.opencode
功能特性
- 内联建议- 在编辑器中获取 AI 建议
- 侧边栏面板- 专用的对话面板
- 上下文感知- 自动包含相关文件上下文
- 快捷命令- 通过命令面板快速访问
AI 中文社
