Use o Cursor CLI no GitHub Actions e outros sistemas de CI/CD para automatizar tarefas de desenvolvimento.

Integração com GitHub Actions

Configuração básica:
- name: Instalar Cursor CLI
  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 "Seu prompt aqui" --model gpt-5

Exemplos de cookbook

Confere nossos exemplos de cookbook para fluxos de trabalho práticos: documentação que se atualiza automaticamente e correção de problemas em CI.

Outros sistemas de CI

Use a CLI do Cursor em qualquer sistema de CI/CD com:
  • Execução de scripts shell (bash, zsh, etc.)
  • Variáveis de ambiente para configuração da chave de API
  • Conectividade 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 Auto Update Documentation, o primeiro workflow permite que o agente:
  • Analise mudanças no PR
  • Crie e gerencie branches do git
  • Faça commits e push das mudanças
  • Publique comentários em pull requests
  • Trate todos os cenários de erro
- name: Update docs (full autonomy)
  run: |
    cursor-agent -p "You have full access to git, GitHub CLI, and PR operations. 
    Handle the entire docs update workflow including commits, pushes, and PR comments."

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álise complexa e modificações de arquivos enquanto operações críticas permanecem determinísticas e auditáveis.
Limita as operações do agente enquanto etapas críticas são tratadas em etapas separadas do workflow. Melhor controle e previsibilidade. Exemplo: O segundo workflow no mesmo cookbook restringe o agente a apenas modificações de arquivos:
- name: Generate docs updates (restricted)
  run: |
    cursor-agent -p "IMPORTANT: Do NOT create branches, commit, push, or post PR comments. 
    Only modify files in the working directory. A later workflow step handles publishing."

- name: Publish docs branch (deterministic)
  run: |
    # Deterministic git operations handled by CI
    git checkout -B "docs/${{ github.head_ref }}"
    git add -A
    git commit -m "docs: update for PR"
    git push origin "docs/${{ github.head_ref }}"

- name: Post PR comment (deterministic)  
  run: |
    # Deterministic PR commenting handled by CI
    gh pr comment ${{ github.event.pull_request.number }} --body "Docs updated"

Restrições baseadas em permissões

Usa as permission configurations 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

Define a variável de ambiente CURSOR_API_KEY:
env:
  CURSOR_API_KEY: ${{ secrets.CURSOR_API_KEY }}
Tu podes obter tua chave de API nas configurações do Cursor.