Skip to content
OpenCode
首页文档

GitHub

在 GitHub issues 和 pull-requests 中使用 OpenCode。

OpenCode 与你的 GitHub 工作流集成。在评论中提到 /opencode 或 /oc，OpenCode 将在你的 GitHub Actions runner 中执行任务。

功能特性

  • 处理问题：让 OpenCode 查看一个问题并向你解释。
  • 修复与实现：让 OpenCode 修复一个问题或实现一个功能。它将在新分支中工作，并提交一个包含所有更改的 PR。
  • 安全：OpenCode 在你的 GitHub runner 内部运行。

安装

在位于 GitHub 仓库中的项目里运行以下命令：

Terminal window
opencode github install

这将引导你完成安装 GitHub 应用、创建工作流和设置密钥的步骤。

手动设置

或者你也可以手动进行设置。

  1. 安装 GitHub 应用

    前往 github.com/apps/opencode-agent。确保它已安装在目标仓库上。

  2. 添加工作流

    在你的仓库的 .github/workflows/opencode.yml 文件中添加以下工作流。确保在 env 中设置合适的 model 和所需的 API 密钥。

    .github/workflows/opencode.yml
    name: opencode
    

    on:
      issue_comment:
        types: [created]
      pull_request_review_comment:
        types: [created]
    

    jobs:
      opencode:
        if: |
          contains(github.event.comment.body, '/oc') ||
          contains(github.event.comment.body, '/opencode')
        runs-on: ubuntu-latest
        permissions:
          id-token: write
        steps:
          - name: Checkout repository
            uses: actions/checkout@v4
            with:
              fetch-depth: 1
    

          - name: Run OpenCode
            uses: anomalyco/opencode/github@latest
            env:
              ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
            with:
              model: anthropic/claude-sonnet-4-20250514
              # share: true
              # github_token: xxxx

  3. 将 API 密钥存储在 secrets 中

    在你的组织或项目设置中，在左侧展开 Secrets and variables 并选择 Actions。然后添加所需的 API 密钥。

配置

  • model: OpenCode 使用的模型。格式为 provider/model。此项为必填。

  • agent: 使用的 agent。必须是主 agent。如果未找到，则回退到配置中的 default_agent 或 "build"。

  • share: 是否共享 OpenCode 会话。对于公共仓库，默认为 true。

  • prompt: 可选的、用于覆盖默认行为的自定义提示词。使用此项来自定义 OpenCode 处理请求的方式。

  • token: 可选的 GitHub 访问令牌，用于执行创建评论、提交更改和打开拉取请求等操作。默认情况下，OpenCode 使用来自 OpenCode GitHub App 的安装访问令牌，因此提交、评论和拉取请求将显示为来自该应用。

    或者，您也可以使用 GitHub Action runner 的内置 GITHUB_TOKEN，而无需安装 OpenCode GitHub App。只需确保在您的工作流程中授予所需的权限：

    permissions:
      id-token: write
      contents: write
      pull-requests: write
      issues: write

    如果愿意，您也可以使用个人访问令牌(PAT)。

支持的事件类型

OpenCode 可以通过以下 GitHub 事件触发：

事件类型触发条件详情
issue_comment在 issue 或 PR 上发表评论在评论中提及 /opencode 或 /oc。OpenCode 会读取上下文，并可创建分支、开启 PR 或回复。
pull_request_review_comment在 PR 中对特定代码行发表评论在代码审查时提及 /opencode 或 /oc。OpenCode 会接收到文件路径、行号和差异上下文。
issuesissue 被开启或编辑当 issue 被创建或修改时自动触发 OpenCode。需要提供 prompt 输入。
pull_requestPR 被开启或更新当 PR 被开启、同步或重新开启时自动触发 OpenCode。适用于自动化代码审查。
schedule基于 Cron 的定时任务按计划运行 OpenCode。需要提供 prompt 输入。输出会发送到日志和 PR（因为没有 issue 可以评论）。
workflow_dispatch从 GitHub UI 手动触发通过 Actions 标签页按需触发 OpenCode。需要提供 prompt 输入。输出会发送到日志和 PR。

定时任务示例

按计划运行 OpenCode 以执行自动化任务：

.github/workflows/opencode-scheduled.yml
name: Scheduled OpenCode Task


on:
  schedule:
    - cron: "0 9 * * 1" # 每周一 UTC 时间上午 9 点


jobs:
  opencode:
    runs-on: ubuntu-latest
    permissions:
      id-token: write
      contents: write
      pull-requests: write
      issues: write
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4


      - name: Run OpenCode
        uses: anomalyco/opencode/github@latest
        env:
          ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
        with:
          model: anthropic/claude-sonnet-4-20250514
          prompt: |
            审查代码库中的任何 TODO 注释并创建摘要。
            如果发现值得处理的问题，请创建一个 issue 来跟踪它们。

对于定时事件，prompt 输入是必需的，因为没有评论可以提取指令。定时工作流运行时没有用户上下文来进行权限检查，因此如果你期望 OpenCode 创建分支或 PR，工作流必须授予 contents: write 和 pull-requests: write 权限。

拉取请求示例

当 PR 被创建或更新时自动进行评审：

.github/workflows/opencode-review.yml
name: opencode-review


on:
  pull_request:
    types: [opened, synchronize, reopened, ready_for_review]


jobs:
  review:
    runs-on: ubuntu-latest
    permissions:
      id-token: write
      contents: read
      pull-requests: read
      issues: read
    steps:
      - uses: actions/checkout@v4
      - uses: anomalyco/opencode/github@latest
        env:
          ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
        with:
          model: anthropic/claude-sonnet-4-20250514
          prompt: |
            评审此拉取请求：
            - 检查代码质量问题
            - 寻找潜在的错误
            - 提出改进建议

对于 pull_request 事件，如果没有提供 prompt，OpenCode 默认会对拉取请求进行评审。

问题分类示例

自动处理新问题的分类。此示例筛选账户创建时间超过 30 天的用户以减少垃圾信息：

.github/workflows/opencode-triage.yml
name: Issue Triage


on:
  issues:
    types: [opened]


jobs:
  triage:
    runs-on: ubuntu-latest
    permissions:
      id-token: write
      contents: write
      pull-requests: write
      issues: write
    steps:
      - name: Check account age
        id: check
        uses: actions/github-script@v7
        with:
          script: |
            const user = await github.rest.users.getByUsername({
              username: context.payload.issue.user.login
            });
            const created = new Date(user.data.created_at);
            const days = (Date.now() - created) / (1000 * 60 * 60 * 24);
            return days >= 30;
          result-encoding: string


      - uses: actions/checkout@v4
        if: steps.check.outputs.result == 'true'


      - uses: anomalyco/opencode/github@latest
        if: steps.check.outputs.result == 'true'
        env:
          ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
        with:
          model: anthropic/claude-sonnet-4-20250514
          prompt: |
            Review this issue. If there's a clear fix or relevant docs:
            - Provide documentation links
            - Add error handling guidance for code examples
            Otherwise, do not comment.

对于 issues 事件，由于没有评论可以提取指令，prompt 输入是必需的。

自定义提示词

覆盖默认提示词，根据您的工作流程自定义 OpenCode 的行为。

.github/workflows/opencode.yml
- uses: anomalyco/opencode/github@latest
  with:
    model: anthropic/claude-sonnet-4-5
    prompt: |
      审查此拉取请求：
      - 检查代码质量问题
      - 寻找潜在的错误
      - 提出改进建议

这对于强制执行与您项目相关的特定审查标准、编码规范或关注领域非常有用。

示例

以下是一些关于如何在 GitHub 中使用 OpenCode 的示例。

  • 解释问题

    在 GitHub issue 中添加此评论。

    /opencode explain this issue

    OpenCode 将读取整个讨论串，包括所有评论，并回复清晰的解释。

  • 修复问题

    在 GitHub issue 中，输入：

    /opencode fix this

    OpenCode 将创建一个新分支，实施更改，并打开一个包含这些更改的 PR。

  • 审查 PR 并进行更改

    在 GitHub PR 上留下以下评论。

    删除 S3 中的附件当笔记被移除时 /oc

    OpenCode 将实施所请求的更改并将其提交到同一个 PR。

  • 审查特定代码行

    直接在 PR 的 “文件” 选项卡中对代码行发表评论。OpenCode 会自动检测文件、行号和差异上下文，以提供精确的响应。

    [在文件选项卡中对特定行发表评论]
    /oc 在这里添加错误处理

    当对特定行进行评论时，OpenCode 会收到：

    • 正在审查的确切文件
    • 特定的代码行
    • 周围的差异上下文
    • 行号信息

    这使得可以进行更有针对性的请求，而无需手动指定文件路径或行号。