OpenCode入门使用指南

发表于 更新于 分类于

简介 | OpenCode

来源: https://opencode.ai/docs/

简介

开始使用 OpenCode。

OpenCode 是一个开源的 AI 编程智能体。它提供基于终端的界面、桌面应用程序或 IDE 扩展。

OpenCode TUI with the opencode theme

让我们开始吧。

先决条件

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

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

安装

安装 OpenCode 最简单的方法是通过安装脚本。

终端窗口

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

你也可以使用以下命令安装：

终端窗口

1
npm install -g opencode-ai

终端窗口

1
bun install -g opencode-ai

终端窗口

1
pnpm install -g opencode-ai

终端窗口

1
yarn global add opencode-ai
  • 在 macOS 和 Linux 上使用 Homebrew

终端窗口

1
brew install anomalyco/tap/opencode

我们建议使用 OpenCode tap 以获取最新版本。官方的 brew install opencode formula 由 Homebrew 团队维护，更新频率较低。

  • 在 Arch Linux 上使用 Paru

终端窗口

1
paru -S opencode-bin

Windows

推荐：使用 WSL

为了在 Windows 上获得最佳体验，我们建议使用 Windows Subsystem for Linux (WSL)。它提供了更好的性能，并完全兼容 OpenCode 的功能。

  • 使用 Chocolatey

终端窗口

1
choco install opencode
  • 使用 Scoop

终端窗口

1
scoop install opencode
  • 使用 NPM

终端窗口

1
npm install -g opencode-ai
  • 使用 Mise

终端窗口

1
mise use -g github:anomalyco/opencode
  • 使用 Docker

终端窗口

1
docker run -it --rm ghcr.io/anomalyco/opencode

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

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

配置

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

如果你是第一次使用 LLM 提供商，我们建议使用 OpenCode Zen。
这是 OpenCode 团队测试和验证过的精选模型列表。

  1. 在 TUI 中运行 /connect 命令，选择 opencode，然后前往 opencode.ai/auth。
1
/connect
  1. 登录，添加你的账单详细信息，并复制你的 API 密钥。
  2. 粘贴你的 API 密钥。
1
> API key... enter

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

初始化

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

终端窗口

1
cd /path/to/project

然后运行 OpenCode。

终端窗口

1
opencode

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

1
/init

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

提示：
你应该将项目的 AGENTS.md 文件提交到 Git。

这有助于 OpenCode 理解项目结构和使用的编码模式。

用法

现在你准备好使用 OpenCode 来处理你的项目了。随意问它任何问题！

如果你是第一次使用 AI 编程智能体，这里有一些可能对你有帮助的例子。

提问

你可以让 OpenCode 向你解释代码库。

提示：
使用 @ 键在项目中模糊搜索文件。

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

如果代码库中有一部分不是你编写的，这会很有帮助。

添加功能

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

  1. 创建计划

OpenCode 有一个 计划模式，它禁用其进行更改的能力，而是建议它将如何实现该功能。

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

1
<TAB>

现在让我们描述我们要它做什么。

1
2
3
When a user deletes a note, we'd like to flag it as deleted in the database.
Then create a screen that shows all the recently deleted notes.
From this screen, the user can undelete a note or permanently delete it.

你要给 OpenCode 足够的细节来理解你想要什么。把它当作是在跟你团队里的初级开发人员交谈。

提示：
给 OpenCode 充足的上下文和例子，以帮助它理解你想要什么。

  1. 迭代计划

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

1
2
We'd like to design this new screen using a design I've used before.
[Image #1] Take a look at this image and use it as a reference.

提示：
将图片拖放到终端中以将其添加到提示中。

OpenCode 可以扫描你给它的任何图片并将它们添加到提示中。你可以通过将图片拖放到终端来做到这一点。

  1. 构建功能

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

1
<TAB>

然后让它进行更改。

1
Sounds good! Go ahead and make the changes.

进行更改

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

1
2
3
We need to add authentication to the /settings route. Take a look at how this is
handled in the /notes route in @packages/functions/src/notes.ts and implement
the same logic in @packages/functions/src/settings.ts

你要确保提供足够多的细节，以便 OpenCode 做出正确的更改。

撤销更改

假设你让 OpenCode 做一些更改。

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

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

1
/undo

OpenCode 现在将恢复你所做的更改并再次显示你的原始消息。

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

从这里你可以调整提示并让 OpenCode 重试。

提示：
你可以多次运行 /undo 来撤销多个更改。

或者你可以使用 /redo 命令 重做 更改。

1
/redo

分享

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

1
/share

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

注意：
对话默认不共享。

这里有一个与 OpenCode 的 对话示例。

自定义

就是这样！你现在是使用 OpenCode 的专家了。

为了让它更适合你，我们建议 选择一个主题、自定义键绑定、配置代码格式化程序、创建自定义命令，或者摆弄 OpenCode 配置。