---
title: Quickstart
description: Add the action to a workflow and read the agent response back.
---

Run a [Cursor](https://cursor.com) 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:

```yaml
- 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

The `permissions` input does not restrict the agent today. Passing `read-only` will not stop it from editing files or running shell commands. Tool restrictions connect to the SDK in v2.

Read [Behaviour](/behaviour) before wiring this into anything that gates a merge.