Skip to content
OpenCode 中文文档
HomeDocs

GitHub

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

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

功能

  • 分拣 Issue: 让 OpenCode 调查某个 Issue 并向你解释。
  • 修复与实现: 让 OpenCode 修复 Bug 或实现功能。它将在新分支中工作，并提交包含所有更改的 PR。
  • 安全: OpenCode 在你的 GitHub runner 内部运行。

安装

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

Terminal window
opencode github install

这将引导你完成 GitHub App 的安装、工作流的创建以及 Secret 的设置。

手动设置

你也可以手动进行设置。

  1. 安装 GitHub App

    访问 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. 在 Secret 中存储 API 密钥

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

配置

  • model: OpenCode 使用的模型。采用 provider/model 格式。这是 必需 的。

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

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

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

  • token: 可选的 GitHub 访问令牌，用于执行创建评论、提交更改和开启 PR 等操作。默认情况下，OpenCode 使用来自 OpenCode GitHub App 的安装访问令牌，因此提交、评论和 PR 将显示为来自该 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 会接收文件路径、行号和 diff 上下文。
issuesIssue 被打开或编辑当 Issue 被创建或修改时自动触发 OpenCode。需要 prompt 输入。
pull_requestPR 被打开或更新当 PR 被打开、同步或重新打开时自动触发 OpenCode。适用于自动化审查。
schedule基于 Cron 的定时任务按计划运行 OpenCode。需要 prompt 输入。输出将发送到日志和 PR（没有可评论的 Issue）。
workflow_dispatch从 GitHub UI 手动触发通过 Actions 选项卡按需触发 OpenCode。需要 prompt 输入。输出将发送到日志和 PR。

定时任务示例

你可以配置定时任务来自动化你的工作流程。

.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 权限。

Pull Request 示例

在 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：
            - 检查代码质量问题
            - 查找潜在的 Bug
            - 提出改进建议

对于 pull_request 事件，如果未提供 prompt，OpenCode 默认会审查该 pull request。

Issue 分拣示例

你可以使用 OpenCode 来自动化 Issue 的分拣工作。

.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: |
            审查此 Issue。如果有明确的修复方案或相关的文档：
            - 提供文档链接
            - 为代码示例提供错误处理指导
            否则，请勿评论。

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

自定义提示词

你可以为 GitHub 操作配置自定义提示词。

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

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

示例

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

  • 解释 Issue

    在 GitHub Issue 中添加此评论。

    /opencode 解释此 issue

    OpenCode 将读取整个线程（包括所有评论），并给出清晰的解释。

  • 修复 Issue

    在 GitHub Issue 中说：

    /opencode 修复此问题

    OpenCode 将创建一个新分支，实现更改，并开启一个包含更改的 PR。

  • 审查 PR 并进行更改

    在 GitHub PR 上留下以下评论。

    删除备注时也从 S3 中删除附件 /oc

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

  • 审查特定的代码行

    直接在 PR 的 “Files” 选项卡中的代码行上留言。OpenCode 会自动检测文件、行号和 diff 上下文，以提供精确的回复。

    [在 Files 选项卡中的特定行留言]
    /oc 在此处添加错误处理

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

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

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