跳转到内容
OpenCode
HomeDocs

简介

开始使用 OpenCode。

OpenCode 是一个开源的 AI 编程助手。它提供终端界面、桌面应用和 IDE 扩展等多种使用方式。

OpenCode TUI with the opencode theme

让我们开始吧。

前提条件

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

  1. 一个现代终端模拟器，例如：

  2. 你想使用的 LLM 提供商的 API 密钥。

安装

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

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

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

  • 使用 Node.js

    Terminal window
    npm install -g opencode-ai

  • 在 macOS 和 Linux 上使用 Homebrew

    Terminal window
    brew install anomalyco/tap/opencode

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

  • 在 Arch Linux 上使用 Paru

    Terminal window
    paru -S opencode-bin

Windows

  • 使用 Chocolatey

    Terminal window
    choco install opencode

  • 使用 Scoop

    Terminal window
    scoop bucket add extras
    scoop install extras/opencode

  • 使用 NPM

    Terminal window
    npm install -g opencode-ai

  • 使用 Mise

    Terminal window
    mise use -g github:anomalyco/opencode

  • 使用 Docker

    Terminal window
    docker run -it --rm ghcr.io/anomalyco/opencode

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

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

配置

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

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

  1. 在 TUI 中运行 /connect 命令，选择 opencode，然后前往 opencode.ai/auth。

    /connect

  2. 登录，添加你的账单信息，然后复制你的 API 密钥。

  3. 粘贴你的 API 密钥。

    ┌ API key
    │
    │
    └ enter

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

初始化

配置好提供商后，你可以导航到你想要工作的项目。

Terminal window
cd /path/to/project

然后运行 OpenCode。

Terminal window
opencode

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

/init

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

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

使用

你现在可以使用 OpenCode 来处理你的项目了。随意向它提问！

如果你是 AI 编程助手的新手，这里有一些可能有帮助的示例。

提问

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

@packages/functions/src/api/index.ts 中的身份验证是如何处理的

如果代码库中有你没有参与开发的部分，这会很有帮助。

添加功能

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

  1. 创建计划

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

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

    <TAB>

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

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

    你需要给 OpenCode 足够的细节来理解你想要什么。像与团队中的初级开发人员交谈一样与它交流会有所帮助。

  2. 迭代计划

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

    我们想使用我之前用过的设计来设计这个新屏幕。
    [图片 #1] 看看这张图片并将其作为参考。

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

  3. 构建功能

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

    <TAB>

    然后让它进行更改。

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

进行更改

对于更直接的更改，你可以让 OpenCode 直接构建它，而不必先审查计划。

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

你需要确保提供足够的细节，以便 OpenCode 进行正确的更改。

撤销更改

假设你让 OpenCode 进行一些更改。

你能重构 @packages/functions/src/api/index.ts 中的函数吗？

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

/undo

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

你能重构 @packages/functions/src/api/index.ts 中的函数吗？

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

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

/redo

分享

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

/share

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

这是一个 示例对话。

自定义

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

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