← Back to home

Getting Started

Install and run your first Resurf automation in under 5 minutes.

1. Install

npm install -g resurf

Requires Node.js 18+ and a Chromium-based browser.

2. Record a workflow

resurf record.start

A browser window opens. Click through your app as normal. Every action is captured.

resurf record.export --format resurf --output login.resurf

Exports the recorded session as a .resurf script.

3. Run the script

resurf run login.resurf

Replays the recorded actions. If something fails, it pauses and lets a human fix the step.

4. Write scripts by hand

The .resurf format is human-readable. You can write scripts directly:

@name "Check Dashboard"
@timeout 30s

navigate "https://app.example.com"
wait.element ".dashboard"

$count = js "document.querySelectorAll('.item').length"
assert $count > 0

screenshot /tmp/dashboard.png
log "Found $count items"

5. Convert Playwright tests

Already have Playwright tests? Convert them:

resurf convert tests/login.spec.ts --output login.resurf

6. Activate Pro

After purchasing, activate your license key:

resurf license activate <your-key>

This unlocks marketplace scripts and signed script execution.