跳至内容
OpenCode
app.header.homeapp.header.docs

GitHub

在 GitHub 问题和拉取请求中使用 OpenCode。

OpenCode 集成到您的 GitHub 工作流程中。在评论中提及 /opencode 或 /oc，OpenCode 将在您的 GitHub Actions 运行器中执行任务。

功能

  • 分类问题：请求 OpenCode 调查问题并向您解释。
  • 修复和实现：请求 OpenCode 修复问题或实现功能。它将在新分支中工作并提交包含所有更改的 PR。
  • 安全：OpenCode 在您的 GitHub 运行器中运行。

安装

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

终端窗口
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@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 密钥存储在 secrets 中

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

配置

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

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

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

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

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

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

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

    如果更喜欢，您也可以使用个人访问令牌 (PAT)。

支持的事件

OpenCode 可以由以下 GitHub 事件触发

事件类型触发者详情
issue_comment在问题或拉取请求上评论在您的评论中提及 /opencode 或 /oc。OpenCode 会读取上下文并可以创建分支、打开 PR 或回复。
pull_request_review_comment在 PR 的特定代码行上评论在审查代码时提及 /opencode 或 /oc。OpenCode 会接收文件路径、行号和差异上下文。
issues问题被打开或编辑当问题创建或修改时自动触发 OpenCode。需要 prompt 输入。
pull_requestPR 被打开或更新当 PR 被打开、同步或重新打开时自动触发 OpenCode。适用于自动化审查。
schedule基于 Cron 的计划按计划运行 OpenCode。需要 prompt 输入。输出将发送到日志和 PR（没有问题可评论）。
workflow_dispatch从 GitHub UI 手动触发通过“Actions”选项卡按需触发 OpenCode。需要 prompt 输入。输出将发送到日志和 PR。

计划示例

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

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


on:
  schedule:
    - cron: "0 9 * * 1" # Every Monday at 9am UTC


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

拉取请求示例

当 PR 被打开或更新时自动审查 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@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 默认审查拉取请求。

问题分类示例

自动分类新问题。此示例过滤掉创建时间超过 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@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 输入是必需的，因为没有评论可以从中提取指令。

自定义提示

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

.github/workflows/opencode.yml
- 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

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

示例

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

  • 解释一个问题

    在 GitHub 问题中添加此评论。

    /opencode explain this issue

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

  • 修复一个问题

    在 GitHub 问题中，说

    /opencode fix this

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

  • 审查 PR 并进行更改

    在 GitHub PR 上留下以下评论。

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

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

  • 审查特定代码行

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

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

    在特定行上评论时，OpenCode 会接收到

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

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