GitHub

OpenCode 可以与你的 GitHub 工作流集成。在评论中提及 /opencode 或 /oc，OpenCode 就会在你的 GitHub Actions runner 中执行任务。

---

功能

• 分类 issue：让 OpenCode 调查某个 issue 并向你解释。
• 修复和实现：让 OpenCode 修复某个 issue 或实现某个功能。它将在新分支中工作，并提交包含所有变更的 PR。
• 安全：OpenCode 在你的 GitHub runner 中运行。

---

安装

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

opencode github install

该命令将引导你完成 GitHub App 的安装、工作流的创建以及 secrets 的设置。

---

手动设置

你也可以手动进行设置。

1. 安装 GitHub App

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

2. 添加工作流

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

   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@v6
            with:
              fetch-depth: 1
              persist-credentials: false
   
          - 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 key 存储到 secrets

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

---

配置

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

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

• share：是否共享 OpenCode 会话。公共仓库默认为 true。

• prompt：可选的自定义 prompt，用于覆盖默认行为。可用于自定义 OpenCode 处理请求的方式。

• token：可选的 GitHub access token，用于执行创建评论、提交变更和发起 pull request 等操作。默认情况下，OpenCode 使用 OpenCode GitHub App 的安装 access token，因此提交、评论和 pull request 会显示为来自该 App。

  或者，你也可以使用 GitHub Action runner 自带的 GITHUB_TOKEN，而不必安装 OpenCode GitHub App。只需确保在工作流中授予所需的权限即可：

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

  如果你愿意，也可以使用 personal access token（PAT）。

---

支持的事件

OpenCode 可以由以下 GitHub 事件触发：

事件类型	触发方式	说明
issue_comment	在 issue 或 PR 上评论	在评论中提及 /opencode 或 /oc。OpenCode 会读取上下文，并可创建分支、发起 PR 或回复。
pull_request_review_comment	在 PR 中的特定代码行上评论	在 review 代码时提及 /opencode 或 /oc。OpenCode 会接收文件路径、行号和 diff 上下文。
issues	issue 被开启或编辑	当 issue 被创建或修改时自动触发 OpenCode。需要 prompt 输入。
pull_request	PR 被开启或更新	当 PR 被开启、同步或重新开启时自动触发 OpenCode。适用于自动化 review。
schedule	基于 cron 的计划任务	按计划运行 OpenCode。需要 prompt 输入。输出会写入日志和 PR（没有 issue 可供评论）。
workflow_dispatch	从 GitHub UI 手动触发	通过 Actions 标签页按需触发 OpenCode。需要 prompt 输入。输出会写入日志和 PR。

计划任务示例

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

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@v6
        with:
          persist-credentials: false

      - name: Run OpenCode
        uses: anomalyco/opencode/github@latest
        env:
          ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
        with:
          model: anthropic/claude-sonnet-4-20250514
          prompt: |
            Review the codebase for any TODO comments and create a summary.
            If you find issues worth addressing, open an issue to track them.

对于计划事件，prompt 输入是必填的，因为没有评论可供提取指令。计划工作流在运行时没有用户上下文用于权限校验，因此如果你希望 OpenCode 创建分支或 PR，工作流必须授予 contents: write 和 pull-requests: write。

---

Pull Request 示例

在 PR 被开启或更新时自动进行 review：

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@v6
        with:
          persist-credentials: false
      - uses: anomalyco/opencode/github@latest
        env:
          ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          model: anthropic/claude-sonnet-4-20250514
          use_github_token: true
          prompt: |
            Review this pull request:
            - Check for code quality issues
            - Look for potential bugs
            - Suggest improvements

对于 pull_request 事件，如果没有提供 prompt，OpenCode 默认会 review 该 pull request。

---

Issue 分类示例

自动对新 issue 进行分类。此示例会过滤掉注册时间小于 30 天的账号，以减少垃圾信息：

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@v6
        if: steps.check.outputs.result == 'true'
        with:
          persist-credentials: false

      - 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 输入是必填的，因为没有评论可供提取指令。

---

自定义 prompt

覆盖默认 prompt，以针对你的工作流自定义 OpenCode 的行为。

- uses: anomalyco/opencode/github@latest
  with:
    model: anthropic/claude-sonnet-4-5
    prompt: |
      Review this pull request:
      - Check for code quality issues
      - Look for potential bugs
      - Suggest improvements

这对于强制执行特定的 review 标准、代码规范或与你的项目相关的关注点非常有用。

---

示例

以下是一些在 GitHub 中使用 OpenCode 的示例。

• 解释 issue

  在 GitHub issue 中添加如下评论。

  /opencode explain this issue

  OpenCode 会阅读整个讨论（包括所有评论），并给出清晰的解释作为回复。

• 修复 issue

  在 GitHub issue 中说：

  /opencode fix this

  OpenCode 会创建一个新分支，实现相关变更，并发起一个包含这些变更的 PR。

• Review PR 并修改

  在 GitHub PR 上留下以下评论：

  Delete the attachment from S3 when the note is removed /oc

  OpenCode 会实现所请求的变更，并将其提交到同一个 PR 中。

• Review 特定的代码行

  在 PR 的 “Files” 标签页中直接对代码行进行评论。OpenCode 会自动识别文件、行号和 diff 上下文，从而提供精准的回复。

  [Comment on specific lines in Files tab]
  /oc add error handling here

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

  • 正在 review 的具体文件
  • 特定的代码行
  • 周围的 diff 上下文
  • 行号信息

  这样你就可以发起更具针对性的请求，而无需手动指定文件路径或行号。