Cursor integration

What is Cursor?

Cursor provides an agent that can read your codebase, run commands, and modify files. Buddy uses the Cursor Agent CLI to run this agent inside a pipeline.

By integrating Buddy with Cursor you can add the Cursor action to your pipelines and let the agent review code, generate changes, or automate routine engineering tasks on every push, on a schedule, or on demand.

Info
To use Buddy directly from the Cursor editor, See Cursor with Buddy.

Setting up Cursor integration

  1. Go to the Integrations tab and click New integration.

  2. Look up and click Cursor.

Image loading...Cursor on the list of available integrations

  1. A configuration window will show up. Here you provide:
  • Name and ID of the integration
  • Scope - whether the integration is available across the whole Workspace, a single Project, or a specific Environment
  • API key - your Cursor User API Key (see below)
Info
You can adjust who can use the integration and where in the Permissions tab.

Image loading...Cursor integration configuration

  1. Once done, click Add a new integration to finish configuration.

Authorization

Authorize with a Cursor User API Key. The value always starts with crsr_.

To obtain the key:

  1. Sign in to your Cursor account.

Image loading...Signing in to the Cursor dashboard

  1. Go to Cursor API Keys (also linked as Get API key in the form) and click New API Key.

Image loading...User API Keys section in the Cursor dashboard

  1. Name the key and pick how long it stays valid - 30 days, 90 days, 180 days (recommended), 1 year, or never expires. Then click Save.

Image loading...Naming a User API Key and setting its expiration

Info
A key that never expires is convenient for long-running pipelines, but it also never rotates. Prefer a bounded lifetime and set yourself a reminder to swap the key in the integration before it lapses - an expired key fails the action at runtime.
  1. Copy the generated key - Cursor shows it only once and it cannot be retrieved later.

Image loading...User API Key Created window in the Cursor dashboard

  1. Paste it into the API KEY field in Buddy and click Add a new integration. The key is stored as an encrypted secret and passed to the pipeline as a secure environment variable, never saved in plain text in your repository.

Image loading...Cursor integration with the API key filled in

Warning
A User API Key carries Admin scope over your Cursor account, including the headless Agent CLI and the Cloud Agent API. Create a dedicated key per integration so you can revoke it without breaking anything else, and keep the integration Scope as narrow as the pipelines that use it.

Once the integration is added, you can use the Cursor action in your pipeline and reference the integration by its ID.

Info
Read how to configure Cursor with YAML and Cursor POST parameters.

Last modified on Sep 1, 2026