Pular para o conteúdo principal
Usa o Cursor CLI no GitHub Actions e em outros sistemas de CI/CD pra automatizar tarefas de desenvolvimento.

Integração com o GitHub Actions

Configuração básica:
- name: Instalar CLI do Cursor
  run: |
    curl https://cursor.com/install -fsS | bash
    echo "$HOME/.cursor/bin" >> $GITHUB_PATH

- name: Executar Cursor Agent
  env:
    CURSOR_API_KEY: ${{ secrets.CURSOR_API_KEY }}
  run: |
    cursor-agent -p "Teu prompt aqui" --model gpt-5

Exemplos do cookbook

Confere nossos exemplos do cookbook para fluxos de trabalho práticos: atualizando a documentação e corrigindo problemas de CI.

Outros sistemas de CI

Usa o Cursor CLI em qualquer sistema de CI/CD com:
  • Execução de scripts de shell (bash, zsh, etc.)
  • Variáveis de ambiente para configurar a chave de API
  • Conexão com a internet para acessar a API do Cursor

Níveis de autonomia

Escolhe o nível de autonomia do teu agente:

Abordagem de autonomia total

Dá ao agente controle completo sobre operações do Git, chamadas de API e interações externas. Configuração mais simples, exige mais confiança. Exemplo: No nosso cookbook Update Documentation, o primeiro fluxo de trabalho permite que o agente:
  • Analise as mudanças do PR
  • Crie e gerencie branches do Git
  • Faça commit e push das mudanças
  • Publique comentários em pull requests
  • Trate todos os cenários de erro
- name: Atualizar docs (autonomia total)
  run: |
    cursor-agent -p "Você tem acesso total ao git, à GitHub CLI e às operações de PR. 
    Cuide de todo o fluxo de atualização da documentação, incluindo commits, pushes e comentários no PR."

Abordagem de autonomia restrita

Recomendamos usar essa abordagem com restrições baseadas em permissões para workflows de CI em produção. Isso te dá o melhor dos dois mundos: o agente consegue lidar de forma inteligente com análises complexas e modificações de arquivos, enquanto operações críticas permanecem determinísticas e auditáveis.
Limita as operações do agente, tratando etapas críticas em estágios separados do workflow. Mais controle e previsibilidade. Exemplo: O segundo workflow no mesmo cookbook restringe o agente apenas a modificações de arquivos:
- name: Gerar atualizações de docs (restrito)
  run: |
    cursor-agent -p "IMPORTANTE: NÃO criar branches, fazer commit, push ou postar comentários em PR. 
    Modifica só os arquivos no diretório de trabalho. Uma etapa posterior do workflow cuida da publicação."

- name: Publicar branch de docs (determinístico)
  run: |
    # Operações determinísticas de git tratadas pelo CI
    git checkout -B "docs/${{ github.head_ref }}"
    git add -A
    git commit -m "docs: atualização para PR"
    git push origin "docs/${{ github.head_ref }}"

- name: Postar comentário no PR (determinístico)  
  run: |
    # Comentários determinísticos em PR tratados pelo CI
    gh pr comment ${{ github.event.pull_request.number }} --body "Docs atualizados"

Restrições baseadas em permissões

Usa configurações de permissões para aplicar restrições no nível da CLI:
{
  "permissions": {
    "allow": [
      "Read(**/*.md)",
      "Write(docs/**/*)",
      "Shell(grep)",
      "Shell(find)"
    ],
    "deny": [
      "Shell(git)",
      "Shell(gh)", 
      "Write(.env*)",
      "Write(package.json)"
    ]
  }
}

Autenticação

Gerar tua chave de API

Primeiro, gera uma chave de API no teu dashboard do Cursor.

Configurar segredos do repositório

Armazena tua chave de API do Cursor com segurança no teu repositório:
  1. Vai até teu repositório no GitHub
  2. Clica em SettingsSecrets and variablesActions
  3. Clica em New repository secret
  4. Define o nome CURSOR_API_KEY
  5. Cola tua chave de API como valor
  6. Clica em Add secret

Usar em workflows

Define a variável de ambiente CURSOR_API_KEY:
env:
  CURSOR_API_KEY: ${{ secrets.CURSOR_API_KEY }}
I