OpenCode 是一个开源的 AI 编程助手,支持在终端、IDE 或桌面环境中使用。它拥有 60K+ GitHub stars,每月有超过 650,000 名开发者使用。本文将详细介绍如何快速搭建 OpenCode 开发环境。
1. 官方地址与 GitHub 仓库
官方网站:https://opencode.ai/
GitHub 仓库:
文档地址:https://opencode.ai/docs/
OpenCode 支持 75+ LLM 提供商,包括 Claude、GPT、Gemini 等主流模型,同时也支持本地模型运行。它具有以下核心特性:
- LSP 支持:自动为 LLM 加载合适的语言服务器
- 多会话:可在同一项目中并行启动多个代理
- 分享链接:可分享任何会话链接用于参考或调试
- GitHub Copilot 集成:登录 GitHub 即可使用 Copilot 账户
- ChatGPT Plus/Pro 集成:登录 OpenAI 即可使用 ChatGPT 账户
- 任意编辑器:支持终端界面、桌面应用和 IDE 扩展
2. 安装方式
OpenCode 提供多种安装方式,可根据你的操作系统和包管理器选择合适的方法。
通用安装脚本(推荐)
1 | curl -fsSL https://opencode.ai/install | bash |
各平台包管理器安装
macOS(Homebrew):
1 | brew install opencode |
Node.js(npm):
1 | npm install -g opencode |
Bun:
1 | bun install -g opencode |
Arch Linux(paru):
1 | paru -S opencode |
桌面应用
OpenCode 还提供桌面应用,支持 macOS、Windows 和 Linux,可访问 https://opencode.ai/download 下载。
3. 集成 Oh-My-OpenCode 插件
Oh-My-OpenCode 是一个强大的插件,为 OpenCode 提供了丰富的功能扩展,包括 20+ 内置工作流自动化钩子、专业化的 AI 代理、Model Context Protocol 集成等。
GitHub 仓库:https://github.com/code-yeongyu/oh-my-opencode
官方网站:https://ohmyopencode.com/
安装 Oh-My-OpenCode
推荐方式(使用 bunx):
1 | bunx oh-my-opencode install |
备选方式(npm):
1 | npm install -g oh-my-opencode |
备选方式(bun):
1 | bun install -g oh-my-opencode |
备选方式(yarn):
1 | yarn global add oh-my-opencode |
Oh-My-OpenCode 核心功能
- Agents 配置:配置智能代理及其设置
- Hooks 配置:启用或禁用工作流自动化钩子(20+ 内置钩子)
- MCPs 配置:Model Context Protocol 集成
- LSP 配置:添加和配置语言服务器协议
- 实验性功能:配置前沿的实验性选项
配置文件位置
Oh-My-OpenCode 的配置文件位于以下位置(按优先级排序):
.opencode/oh-my-opencode.json- 项目级配置(最高优先级)~/.config/opencode/oh-my-opencode.json- 用户级配置
项目级配置会覆盖用户级配置,允许你在不同项目中使用不同设置。
4. 添加与配置 API Key
配置好 OpenCode 后,需要添加 LLM 提供商的 API Key 才能正常使用。
添加 API Key
使用 OpenCode 的 /connect 命令添加 API Key:
1 | # 启动 OpenCode |
按照提示选择 LLM 提供商并输入 API Key。添加的凭据会存储在 ~/.local/share/opencode/auth.json 文件中。
配置 LLM 提供商
在 OpenCode 配置文件(opencode.json 或 opencode.jsonc)中配置提供商:
1 | { |
配置文件位置
OpenCode 的配置文件可在以下位置放置,按优先级合并:
- 项目目录下的
opencode.json或opencode.jsonc ~/.config/opencode/opencode.json- 其他系统级配置文件
配置文件会被合并而非替换,后续配置只会覆盖冲突的键值。
常用模型配置示例
Anthropic Claude:
1 | { |
OpenAI GPT-4:
1 | { |
Google Gemini:
1 | { |
自定义 Base URL
如需使用代理服务或自定义端点,可配置 Base URL:
1 | { |
总结
通过以上四个步骤,你就可以快速搭建 OpenCode 开发环境了:
- 访问 https://opencode.ai/ 了解官方信息
- 选择合适的安装方式完成 OpenCode 安装
- 使用
bunx oh-my-opencode install集成 Oh-My-OpenCode 插件 - 通过
/connect命令添加 API Key 并在配置文件中设置模型
搭建完成后,你就可以开始使用这个强大的 AI 编程助手来提升开发效率了!
参考资源
- OpenCode 官方文档:https://opencode.ai/docs/
- Oh-My-OpenCode 文档:https://ohmyopencode.com/
- OpenCode GitHub:https://github.com/opencode-ai/opencode
- Oh-My-OpenCode GitHub:https://github.com/code-yeongyu/oh-my-opencode