跳转到内容
案例 生态 源码解读 文档

入门指南

开始使用 OpenCode。

OpenCode 是一个开源的 AI 编程助手。它提供基于终端的界面（TUI）、桌面应用或 IDE 扩展。

OpenCode TUI with the opencode theme

让我们开始吧。

前置要求

在终端中使用 OpenCode，你需要准备：

  1. 一个现代终端模拟器，例如：
  2. 你想使用的 LLM 提供商的 API 密钥。

安装

安装 OpenCode 最简单的方式是使用官方安装脚本：

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

你也可以通过以下方式安装：

使用 Node.js

npm install -g opencode-ai
# 或
bun install -g opencode-ai
# 或
pnpm install -g opencode-ai
# 或
yarn global add opencode-ai

使用 Homebrew（macOS 和 Linux）

brew install anomalyco/tap/opencode

Arch Linux

sudo pacman -S opencode           # Arch Linux（稳定版）
paru -S opencode-bin              # Arch Linux（AUR 最新版）

Windows

推荐：使用 WSL。在 Windows 上获得最佳体验，我们推荐使用 Windows Subsystem for Linux（WSL）。它提供更好的性能和与 OpenCode 功能的完整兼容性。

choco install opencode # Chocolatey
scoop install opencode    # Scoop
npm install -g opencode-ai    # NPM
mise use -g github:anomalyco/opencode    # Mise
docker run -it --rm ghcr.io/anomalyco/opencode    # Docker

在 Windows 上使用 Bun 安装 OpenCode 的支持目前正在开发中。

你也可以从 Releases 下载二进制文件。

配置

使用 OpenCode，你可以通过配置 API 密钥来使用任何 LLM 提供商。

如果你不熟悉 LLM 提供商的使用，我们推荐使用 OpenCode Zen。这是一个经过 OpenCode 团队测试和验证的精选模型列表。

  1. 在 TUI 中运行 /connect 命令，选择 opencode，然后访问 opencode.ai/auth。
/connect
  1. 登录，添加计费信息，然后复制你的 API 密钥。
  2. 粘贴你的 API 密钥。

或者，你可以选择其他提供商。了解更多。

初始化

现在你已经配置了提供商，可以导航到你想要工作的项目。

cd /path/to/project
opencode

接下来，通过运行以下命令来初始化项目的 OpenCode：

/init

这会让 OpenCode 分析你的项目并在项目根目录创建一个 AGENTS.md 文件。

使用方法

现在你已经准备好使用 OpenCode 来处理你的项目了。随意提问吧！

如果你不熟悉 AI 编程助手的使用，这里有一些可能对你有帮助的示例。

提问

你可以让 OpenCode 解释代码库。

How is authentication handled in @packages/functions/src/api/index.ts

如果你不熟悉代码库的某个部分，这将很有帮助。

添加功能

你可以让 OpenCode 为你的项目添加新功能。不过我们首先建议让它创建一个计划。

1. 创建一个计划

OpenCode有一个 Plan 模式，它会禁用修改能力，转而建议 如何 实现该功能。

使用 Tab 键切换到该模式。你会在右下角看到一个指示器。

<TAB>

现在让我们描述我们想要它做的事情。

当用户删除一个笔记时，我们希望将其在数据库中标记为已删除。
然后创建一个屏幕显示所有最近删除的笔记。
从这个屏幕，用户可以恢复笔记或永久删除它。

你需要给 OpenCode 足够的细节来理解你想要什么。把它当作团队中的初级开发者来交流会有帮助。

2. 迭代计划

一旦它给出计划，你可以提供反馈或添加更多细节。

我们希望使用我之前用过的设计来设计这个新屏幕。
[Image #1] 查看这张图片并以此作为参考。

3. 构建功能

一旦你对计划感到满意，通过再次按 Tab 键切换回 Build 模式。

<TAB>

然后让它进行修改。

听起来不错！继续进行修改吧。

进行修改

对于更直接的修改，你可以让 OpenCode 直接构建，而无需先审查计划。

我们需要在 /settings 路由添加身份验证。查看 @packages/functions/src/notes.ts
中 /notes 路由的处理方式，然后在 @packages/functions/src/settings.ts 中
实现相同的逻辑。

确保你提供足够的细节，这样 OpenCode 才会做出正确的修改。

撤销修改

假设你让 OpenCode 做了一些修改。

Can you refactor the function in @packages/functions/src/api/index.ts?

但你意识到这不是你想要的。你可以使用 /undo 命令撤销这些更改。

/undo

OpenCode 现在会撤销你做的更改并再次显示你的原始消息。

Can you refactor the function in @packages/functions/src/api/index.ts?

从这里你可以调整提示并让 OpenCode 再试一次。

分享

你与 OpenCode 的对话可以与你的团队分享。

/share

这将创建指向当前对话的链接并复制到剪贴板。

这是一个 OpenCode 对话示例。

自定义

就是这样！你现在已经是 OpenCode 的高手了。

为了让 OpenCode 成为你自己的，我们推荐选择一个主题、自定义快捷键、配置代码格式化器、创建自定义命令，或者尝试 OpenCode 配置。