跳转到内容
展示 生态 文档

快速上手

在不到5分钟内开始使用 Opencode。

前提条件

  • macOS 或 Linux（支持 Windows WSL2）
  • Node.js 18+（某些语言服务器需要）
  • API 密钥（OpenAI、Anthropic 或 Gemini）

安装

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

curl -sL opencode.ai/install | bash

配置 API 密钥

安装完成后，您需要为选择的 AI 提供商配置 API 密钥。这允许 Opencode 向 AI 模型发出请求。

步骤 1：获取 API 密钥

首先，您需要从首选的 AI 提供商获取 API 密钥：

步骤 2：配置 API 密钥

运行 opencode auth login 命令来配置您的 API 密钥：

# 开始交互式认证
opencode auth login

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

系统会提示您输入 API 密钥。输入后，它将被安全地存储在 ~/.local/share/opencode/auth.json 中。

项目初始化

为了帮助 Opencode 更好地了解您的项目结构，您应该使用 /init 命令初始化您的项目。这会创建一个 AGENTS.md 文件，记录您项目的结构和关键组件。

使用 /init 命令

选项 1：从终端

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

opencode init

选项 2：从 TUI

启动 Opencode TUI：

opencode tui

然后输入 /init 命令：

/init

/init 命令的作用

/init 命令：

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

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

您的第一个任务

现在您已经配置了 API 密钥并初始化了项目，您可以开始使用 Opencode 了。

启动 TUI

opencode tui

示例任务

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

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

验证

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

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

后续步骤

  • 浏览 配置 页面以根据您的工作流程自定义 Opencode
  • 查看 CLI 参考 了解更多命令
  • 访问 生态系统 页面发现社区工具和资源

祝您使用 Opencode 编码愉快！