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

​
Integração com o GitHub Actions

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

- name: Run Cursor Agent
  env:
    CURSOR_API_KEY: ${{ secrets.CURSOR_API_KEY }}
  run: |
    cursor-agent -p "Your prompt here" --model gpt-5

​
Exemplos do cookbook

Confere nossos exemplos do cookbook para fluxos de trabalho práticos: atualizar documentação e corrigir 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 à 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 total 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 workflow permite que o agente:
  • Analise mudanças do PR
  • Crie e gerencie branches do git
  • Faça commits e pushes 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ão 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 passos separados do workflow. Melhor controle e previsibilidade. Exemplo: O segundo workflow no mesmo cookbook restringe o agente apenas a 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ão

Usa configurações de permissão para impor 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

​
Gere sua chave de API

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

​
Configure 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 Settings → Secrets and variables → Actions
  3. Clica em New repository secret
  4. Dá o nome CURSOR_API_KEY
  5. Cola tua chave de API como valor
  6. Clica em Add secret

​
Use em workflows

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