Docs

Getting started

Four steps from signing in to your first change. The first four take about ten minutes. Checks and previews are for whoever looks after your code, and can come later.

1Sign in

Go to app.patchwell.dev and choose Continue with GitHub, or ask for a sign-in link by email. The link works once, for 15 minutes.

2Connect a repository

PatchWell doesn’t host your code. Choose Connect a repository and pick one from GitHub. Your code stays there, and every change comes back to it as a pull request.

3Give your agents a computer

Choose Add a computer. Pick a cloud computer and PatchWell sets it up for you. Or use your own Linux machine or Apple-silicon Mac by running this on it, once:

curl -fsSL https://dl.patchwell.dev/install.sh | sh \
  && ~/.local/bin/patchwell-runtime add-host --paste

Then choose Sign an agent in. Agents need a paid Claude or ChatGPT plan.

4Start a thread

Choose Start a thread and say what you want changed, the way you would to a colleague. For example: “On a phone, the pricing table runs off the screen. Stack the plans instead.” The agent reads the code, makes the change and opens a pull request. Invite an engineer to the thread to look over it.

5Add your checks

Checks are the automatic tests that run on every change. Add .patchwell/pipeline.yml to the repository:

runner: linux-4        # every job, unless it names its own
jobs:
  - name: test
    run: cargo test
    runner: linux-16   # this job only

Coming from GitHub Actions? Most settings keep their names:

GitHub Actions.patchwell/pipeline.yml
runs-on: ubuntu-latestrunner: linux-2
uses: actions/checkoutnothing: already checked out
uses: actions/setup-nodeimage: node:22
${{ secrets.X }}declare X under secrets:, read $X
timeout-minutestimeout_minutes (at most 60)
environment: with reviewersapproval: true

How checks work with GitHub

6Turn on previews

A preview is a live copy of your product for each change. If your app builds from a Dockerfile, add .patchwell/preview.yml:

version: 2
build: {dockerfile: Dockerfile, port: 3000}

The next thread shows a link to its preview. More about previews