介绍

先搞懂:OpenCode到底是什么?

OpenCode 是基于LLM的Agent运行时框架,本质上是一款可本地部署的开源AI编码助手,面向追求命令行操作效率的开发者设计。它最大的优势的是「本地运行+多场景适配」:所有代码和数据都在本地处理,不上传至第三方服务器,完美适配处理私有、敏感代码的需求;同时支持Windows、macOS、Linux三大系统,可与任意编辑器协同,无需局限于特定IDE插件生态。
核心能力亮点(新手必知):

  • 自然语言交互:无需记忆复杂命令,用日常话术就能让AI完成代码相关操作(如“修复main.js中的语法错误”);

  • 多模型兼容:支持OpenAI、Anthropic Claude、国内模型等多种提供商,也可接入本地模型(如通过Ollama运行的模型);

  • 深度上下文感知:能遍历项目文件结构、解析源码依赖,持续维护项目状态,不会在多轮交互中丢失上下文;

  • 丰富扩展能力:支持SDK集成、服务器部署,可通过API接口编程式交互,还能与Git等版本控制系统深度集成;

  • 开箱即用:部署流程简单,5分钟即可完成安装,无需复杂配置,新手也能快速上手。

前置准备

OpenCode依赖Node.js环境运行,因此部署前需先确认本地已安装Node.js(推荐LTS版本,v20.x.x最佳),否则会导致安装失败。
检查Node.js是否安装:

node -v  # 输出版本号(如v20.10.0)即表示已安装

部署

npm install -g @opencode-ai/cli  # npm 安装OpenCode CLI(核心组件)

opencode --version  # 输出版本号即成功

npm install @opencode-ai/sdk   # 从 npm 安装OpenCode SDK(可选,用于编程式交互)


/models #选择模型

执行/models命令后,终端会提示选择模型提供商,常见选项如下(根据自身需求选择):

  • OpenAI:需提前获取OpenAI API Key(地址:platform.openai.com/api-keys);

  • Anthropic Claude:需获取Claude API Key;

  • 国内模型:如智谱GLM等,可通过官方链接免费获取API Key(如智谱:www.bigmodel.cn/glm-coding);

  • 本地模型:若已通过Ollama等工具部署本地模型,可选择对应选项,无需API Key,更安全隐私。

选择完成后,输入对应API Key(本地模型无需输入),即可完成模型连接,准备启动OpenCode。

配置环境变量

path 添加 …node_global\node_modules\opencode-ai\node_modules\opencode-windows-x64\bin

启动方式

1 CLI 启动

CLI启动是最常用的方式,启动后直接在终端与OpenCode交互,适合日常编程、快速调试等场景,命令如下:

opencode  

opencode --port 8081  #指定端口

2 web 启动

若觉得终端界面不够直观,可通过Web方式启动,OpenCode会自动生成一个Web界面,通过浏览器即可操作,命令如下:

opencode web

进阶使用

解锁OpenCode更多实用功能,部署并启动OpenCode后,除了基础的代码生成、调试,还可以利用其丰富的功能提升编程效率,这里分享几个高频实用场景和命令,结合官方文档补充细节

1. 服务器相关操作(进阶必备)

OpenCode启动时会自动启动服务器,也可单独启动无界面服务器,用于编程式交互或多客户端连接,命令如下:

opencode serve  # 启动独立无界面服务器(默认端口4096)
opencode serve --port 8082 --cors http://localhost:5173  # 自定义端口+允许指定浏览器来源访问

补充:可通过设置环境变量保护服务器安全,添加HTTP基本认证:

OPENCODE_SERVER_PASSWORD=your-password opencode serve  # 设置密码,用户名默认opencode

服务器启动后,可访问http://:/doc(如http://localhost:4096/doc),查看OpenAPI 3.1规范,用于生成客户端或检查请求响应类型。

2. 常用终端指令(日常高频)

- /connect:重新连接模型(若模型连接失败,可执行此命令重新选择);
- opencode shell:在终端中运行shell命令,AI会自动执行并返回结果;

- /find?pattern=关键词:在项目文件中搜索指定文本,快速定位代码;

- /session:查看所有会话,可创建、删除、切换会话,持久化保存交互记录。

实用场景举例

- 代码调试:输入“帮我修复main.js中的TypeScript类型错误”,OpenCode会自动读取文件内容,分析错误并生成修复代码;
- 项目解析:输入“分析当前项目的架构,生成核心功能说明”,AI会遍历项目文件,生成结构化摘要;

- 脚本生成:输入“生成一个Dockerfile,用于部署Node.js项目”,AI会快速生成符合规范的Dockerfile;

- API开发:输入“写一个基于Express的用户登录接口,包含参数校验和权限验证”,AI会生成完整的接口代码和注释。

实用资源分享

官方文档(详细的API说明、服务器配置、高级功能介绍)
GitHub仓库(查看源码、提交issues、获取最新更新)

Logo

AtomGit 是由开放原子开源基金会联合 CSDN 等生态伙伴共同推出的新一代开源与人工智能协作平台。平台坚持“开放、中立、公益”的理念,把代码托管、模型共享、数据集托管、智能体开发体验和算力服务整合在一起,为开发者提供从开发、训练到部署的一站式体验。

更多推荐