跳转到内容
展示 生态 文档

快速入门

在 5 分钟内开始使用 OpenCode。

前提条件

  • macOS、Linux 或 Windows（支持 WSL2）
  • Node.js 18+（某些语言服务器需要）
  • API 密钥（使用内置模型时可选）

安装

在终端中运行以下命令以下载并安装二进制文件：

curl -fsSL https://opencode.ai/install | bash

更多安装选项，请参阅安装页面。

认证

OpenCode 提供多种认证选项，让您快速上手。

选项 1：内置免费模型（Zen）

最简单的入门方式是使用 OpenCode Zen，它提供专为编程优化的精选 AI 模型：

opencode auth login --provider zen

无需 API 密钥 - 直接开始编程！

选项 2：GitHub Copilot

如果您有 GitHub Copilot 订阅：

opencode auth login --provider github

这将打开浏览器进行 GitHub 认证。

选项 3：ChatGPT Plus/Pro

如果您有 ChatGPT Plus 或 Pro 订阅：

opencode auth login --provider openai

这将直接使用您的 ChatGPT 订阅。

选项 4：自定义 API 密钥

对于其他提供商，您可以配置自己的 API 密钥：

# 启动交互式认证
opencode auth login

# 或使用特定提供商认证
opencode auth login --provider anthropic
opencode auth login --provider google

支持的提供商：

您的 API 密钥安全地存储在 ~/.local/share/opencode/auth.json 中。

项目初始化

为了帮助 OpenCode 更好地理解您的项目结构，请使用 /init 命令初始化您的项目。

使用 /init 命令

选项 1：从终端

导航到您的项目目录并运行：

opencode init

选项 2：从 TUI

启动 OpenCode TUI：

opencode tui

然后输入 /init 命令：

/init

/init 命令的作用

/init 命令：

  1. 扫描您的项目目录结构
  2. 识别关键文件和组件
  3. 在项目根目录创建 AGENTS.md 文件
  4. 为 AI 参考记录重要的项目信息

这有助于 AI 更好地理解您的代码库，从而提供更准确和相关的响应。

您的第一个任务

现在您已经配置了认证并初始化了项目，可以开始使用 OpenCode 了。

启动 TUI

opencode tui

在代理之间切换

OpenCode 包含两个内置代理：

  • build（默认）：用于开发工作的完全访问代理
  • plan：用于分析和代码探索的只读代理

按 Tab 键在代理之间切换。

示例任务

以下是一些您可以尝试的示例任务：

  1. 代码解释：“解释这个项目中的认证流程是如何工作的”
  2. 错误修复：“查找并修复登录组件中的错误”
  3. 重构：“重构用户配置文件组件以使用 hooks”
  4. 文档：“为 API 端点生成文档”
  5. 测试：“为结账功能编写单元测试”

多会话支持

您可以在同一项目中并行运行多个代理：

# 启动一个新会话
opencode tui

# 在另一个终端中，启动另一个会话
opencode tui

每个会话独立运行，允许您同时处理不同的任务。

分享会话链接

您可以分享任何会话链接以供参考或调试：

opencode share <session-id>

这将生成一个可分享的链接，其他人可以使用它来查看您的会话。

验证

要验证您的设置是否正常工作：

  1. 运行 opencode models 查看您配置的提供商可用的模型
  2. 运行 opencode stats 检查您的使用统计
  3. 尝试一个简单的查询，如”解释如何在 JavaScript 中使用 promises”

下一步

祝您使用 OpenCode 编程愉快！