RWX quickstart with Cursor Origin

If you're not already familiar with RWX, you may want to start with the general getting started guide.

Install the Cursor Origin app

Visit your RWX organization's VCS integrations page and click "Connect Cursor Origin", then follow the instructions to install the RWX Cursor Origin app.

This gives RWX access to read your repository contents, which is necessary to read the run definitions in your .rwx directory. It also gives RWX access to a few other permissions which are necessary to trigger your runs via webhooks and report statuses.

Testing the Cursor Origin integration

Run definition

To test the Cursor Origin integration, create a file named .rwx/push.yml, commit, and push it to your repository.

on:
  origin:
    push:

base:
  image: ubuntu:24.04
  config: rwx/base 1.1.1

tasks:
  - key: hello-world
    run: echo hello world

Cursor Origin status check

Take a look at the commit you just pushed in the Cursor Origin UI. It should show a commit status for the RWX run. Click the status to open the RWX UI and see the hello-world task.

Cloning repositories

Installing the Cursor Origin app also provides a way to clone your repositories.

You can use the token in the format origin.token with the git/clone package to clone your repository.

To test cloning, update .rwx/push.yml to contain the following, and then commit and push:

on:
  origin:
    push:
      init:
        commit-sha: ${{ event.git.sha }}

base:
  image: ubuntu:24.04
  config: rwx/base 1.1.1

tasks:
  - key: code
    call: git/clone 2.0.8
    with:
      repository: https://origin.cursor.com/YOUR_ORG/YOUR_REPO.git
      ref: ${{ init.commit-sha }}
      github-token: ${{ origin.token }}

Next steps

For continuing to build a graph of tasks on top of your code task, see the CI reference workflow guide.

For triggering runs on pull requests as well as pushes, see Cursor Origin Triggers.