GitHub

Use o OpenCode em issues e pull requests do GitHub.

O OpenCode se integra ao seu fluxo de trabalho do GitHub. Mencione /opencode ou /oc no seu comentário e o OpenCode executará tarefas dentro do seu runner do GitHub Actions.

Recursos

• Triagem de issues : Peça ao OpenCode para investigar uma issue e explicá-la para você.
• Corrigir e implementar : Peça ao OpenCode para corrigir uma issue ou implementar um recurso. Ele trabalhará em uma nova branch e enviará um PR com todas as alterações.
• Seguro : O OpenCode roda dentro dos seus runners do GitHub.

Instalação

Execute o seguinte comando em um projeto que esteja em um repositório do GitHub:

opencode github install

Isso vai te guiar pela instalação do app do GitHub, criação do workflow e configuração dos secrets.

Configuração manual

Ou você pode configurá-lo manualmente.

1. Instalar o app do GitHub Vá até github.com/apps/opencode-agent (opens in a new tab). Certifique-se de que esteja instalado no repositório de destino.

2. Adicionar o workflow Adicione o seguinte arquivo de workflow em .github/workflows/opencode.yml no seu repositório. Certifique-se de definir o model apropriado e as chaves de API necessárias em env.

   .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. Armazenar as chaves de API nos secrets Nas settings da sua organização ou projeto, expanda Secrets and variables à esquerda e selecione Actions. Depois adicione as chaves de API necessárias.

Configuração

• model: O modelo a ser usado com o OpenCode. Usa o formato provider/model. Isso é obrigatório.

• agent: O agente a ser usado. Deve ser um agente primário. Recorre ao default_agent da config ou a "build" se não for encontrado.

• share: Se deve compartilhar a sessão do OpenCode. O padrão é true para repositórios públicos.

• prompt: Prompt personalizado opcional para substituir o comportamento padrão. Use isso para personalizar como o OpenCode processa as solicitações.

• token: Token de acesso do GitHub opcional para realizar operações como criar comentários, fazer commit de alterações e abrir pull requests. Por padrão, o OpenCode usa o token de acesso de instalação do app do GitHub do OpenCode, então commits, comentários e pull requests aparecem como vindos do app. Como alternativa, você pode usar o GITHUB_TOKEN integrado (opens in a new tab) do runner do GitHub Action sem instalar o app do GitHub do OpenCode. Apenas certifique-se de conceder as permissões necessárias no seu workflow:

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

  Você também pode usar um token de acesso pessoal (opens in a new tab) (PAT) se preferir.

Eventos suportados

O OpenCode pode ser acionado pelos seguintes eventos do GitHub:

Exemplo de agendamento

Rode o OpenCode em um agendamento para realizar tarefas automatizadas:

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.

Para eventos agendados, a entrada prompt é obrigatória, já que não há comentário do qual extrair instruções. Workflows agendados rodam sem um contexto de usuário para verificar permissões, então o workflow precisa conceder contents: write e pull-requests: write se você espera que o OpenCode crie branches ou PRs.

Exemplo de pull request

Revise automaticamente os PRs quando eles são abertos ou atualizados:

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

Para eventos pull_request, se nenhum prompt for fornecido, o OpenCode revisa o pull request por padrão.

Exemplo de triagem de issues

Faça a triagem automática de novas issues. Este exemplo filtra para contas com mais de 30 dias para reduzir spam:

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.

Para eventos issues, a entrada prompt é obrigatória, já que não há comentário do qual extrair instruções.

Prompts personalizados

Substitua o prompt padrão para personalizar o comportamento do OpenCode no seu workflow.

- 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

Isso é útil para aplicar critérios de revisão específicos, padrões de codificação ou áreas de foco relevantes para o seu projeto.

Exemplos

Aqui estão alguns exemplos de como você pode usar o OpenCode no GitHub.

• Explicar uma issue Adicione este comentário em uma issue do GitHub.

  /opencode explain this issue

  O OpenCode lerá toda a thread, incluindo todos os comentários, e responderá com uma explicação clara.

• Corrigir uma issue Em uma issue do GitHub, diga:

  /opencode fix this

  E o OpenCode criará uma nova branch, implementará as alterações e abrirá um PR com elas.

• Revisar PRs e fazer alterações Deixe o seguinte comentário em um PR do GitHub.

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

  O OpenCode implementará a alteração solicitada e fará o commit dela no mesmo PR.

• Revisar linhas de código específicas Deixe um comentário diretamente nas linhas de código na aba "Files" do PR. O OpenCode detecta automaticamente o arquivo, os números de linha e o contexto do diff para fornecer respostas precisas.

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

  Ao comentar em linhas específicas, o OpenCode recebe:

  • O arquivo exato que está sendo revisado
  • As linhas de código específicas
  • O contexto do diff ao redor
  • Informações de números de linha

  Isso permite solicitações mais direcionadas sem precisar especificar caminhos de arquivos ou números de linha manualmente.