Skip to content
OpenCode 中文文档
HomeDocs

介绍

开始使用 OpenCode。

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

OpenCode TUI 使用 opencode 主题

让我们开始吧。

前置条件

要在终端中使用 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 opencode

  • 在 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

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

你也可以从 Releases 中获取二进制文件。

配置

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

如果你是第一次使用 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 为你的项目添加新功能。不过我们建议先让它创建一个计划 (Plan)。

  1. 创建一个计划

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

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

    <TAB>

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

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

    你需要向 OpenCode 提供足够的细节以便它理解你的意图。最好把它当成你团队中的一名初级开发人员来交流。

  2. 迭代计划

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

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

    OpenCode 可以扫描你提供的任何图片并将其添加到提示词中。你可以通过将图片拖放到终端中来完成此操作。

  3. 构建功能

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

    <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 的高手了。

为了让它更符合你的习惯，我们建议 选择一个主题、自定义快捷键、配置代码格式化器、创建自定义命令 或玩转 OpenCode 配置。