Skip to main content

Command Palette

Search for a command to run...

Headless / CI

GitHub Actions

Use a CLI do Cursor 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: |    agent -p "Your prompt here" --model gpt-5

Exemplos do cookbook

Confira nossos exemplos do cookbook com fluxos de trabalho práticos: atualizar a documentação e corrigir issues de CI.

Outros sistemas de CI

Use a CLI do Cursor em qualquer sistema de CI/CD que tenha:

  • 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

Escolha o nível de autonomia do seu 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, mas exige mais confiança.

Exemplo: Em nosso cookbook Update Documentation, o primeiro fluxo de trabalho permite que o agente:

  • Analise as alterações da PR
  • Crie e gerencie branches do Git
  • Faça commit e push das alterações
  • Publique comentários em pull requests
  • Lide com todos os cenários de erro
- name: Update docs (full autonomy)  run: |    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

Limite as operações do agente e realize as etapas críticas em etapas separadas do fluxo de trabalho. Mais controle e previsibilidade.

Exemplo: O segundo fluxo de trabalho no mesmo cookbook restringe o agente apenas a modificações de arquivos:

- name: Generate docs updates (restricted)  run: |    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: |    # Operações determinísticas do Git gerenciadas pela 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: |    # Comentários em PR gerenciados de forma determinística pela CI    gh pr comment ${{ github.event.pull_request.number }} --body "Docs updated"

Restrições baseadas em permissões

Use configurações de permissão para aplicar restrições na 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, gere uma chave de API no dashboard do Cursor.

Configurar segredos do repositório

Armazene com segurança a chave da API do Cursor no repositório usando o GitHub CLI:

# Segredo do repositóriogh secret set CURSOR_API_KEY --repo OWNER/REPO --body "$CURSOR_API_KEY"# Segredo da organização (todos os repositórios)gh secret set CURSOR_API_KEY --org ORG --visibility all --body "$CURSOR_API_KEY"

Como alternativa, use a interface do GitHub: acesse seu repositório → Settings → Secrets and variables → Actions → New repository secret

Uso em fluxos de trabalho

Defina a variável de ambiente CURSOR_API_KEY:

env:  CURSOR_API_KEY: ${{ secrets.CURSOR_API_KEY }}