Documentation / Getting Started / Quick Start

Quick Start

Get up and running with WorkerRun in under a minute.

1

Install the GitHub App

Go to github.com/apps/workerrun/installations/new and click Install. Select the repositories you want to enable.

2

Update your workflow

Change runs-on in your GitHub Actions YAML. Choose the mode that fits your use case:

V8 Isolation Mode — lightweight automation with millisecond cold starts

- runs-on: ubuntu-latest
+ runs-on: worker-run

Container Mode — full Ubuntu environment with git, npm, real filesystem

- runs-on: ubuntu-latest
+ runs-on: worker-run/instance-type=lite
# or: worker-run/instance-type=basic
3

Push & run

That's it. In V8 mode, your job starts in milliseconds with no VMs. In container mode, you get a full Ubuntu environment powered by Cloudflare Sandbox SDK. Both modes support Node.js actions, expressions, and conditional steps.

Next steps