Quickstart

Run a Cursor agent as a step in any GitHub Actions workflow, and read its response back as a step output.

Quickstart

Add a repository secret named CURSOR_API_KEY, then use the action:

- name: Run Cursor Agent
  id: cursor
  uses: PunGrumpy/cursor-action@v1
  with:
    api-key: ${{ secrets.CURSOR_API_KEY }}
    prompt: "Review this PR for security issues and summarize your findings."

- name: Print summary
  env:
    SUMMARY: ${{ steps.cursor.outputs.summary }}
  run: echo "$SUMMARY"

The action runs on ubuntu-latest, windows-latest, and macos-latest.

What it does not do yet

Two inputs are accepted but have no effect. They are documented on Reference, and both are addressed in v2:

• permissions does not restrict the agent. read-only will not stop it from editing files or running shell commands.
• A run that times out or fails inside the agent still reports success.

Read Behaviour before wiring this into anything that gates a merge.