Wrangler

Wrangler is a command-line tool for building with Cloudflare developer products.

Use Wrangler to deploy projects that use the Workers Browser Rendering API.

Install

To install Wrangler, refer to Install and Update Wrangler.

Bindings

Bindings allow your Workers to interact with resources on the Cloudflare developer platform. A browser binding will provide your Worker with an authenticated endpoint to interact with a dedicated Chromium browser instance.

To deploy a Browser Rendering Worker, you must declare a browser binding in your Worker's wrangler.toml configuration file.

Wrangler configuration

If you are using Puppeteer in your Worker code, then you also need to add "nodejs_compat_v2" to the compatibility_flags in your Worker's wrangler.toml configuration. More information here, including for pages functions.

wrangler.toml

# Top-level configuration
name = "browser-rendering"
main = "src/index.ts"
workers_dev = true
compatibility_flags = ["nodejs_compat_v2"]

browser = { binding = "MYBROWSER" }

wrangler.json

{
  "name": "browser-rendering",
  "main": "src/index.ts",
  "workers_dev": true,
  "compatibility_flags": [
    "nodejs_compat_v2"
  ],
  "browser": {
    "binding": "MYBROWSER"
  }
}

After the binding is declared, access the DevTools endpoint using env.MYBROWSER in your Worker code:

const browser = await puppeteer.launch(env.MYBROWSER);

Run npx wrangler dev --remote to test your Worker remotely before deploying to Cloudflare's global network. Local mode support does not exist for Browser Rendering so --remote is required. To deploy, run npx wrangler deploy.

Was this helpful?

What did you like?

Accurate

Easy to understand

Solved my problem

Helped me decide to use the product

Other

What went wrong?

Hard to understand

Incorrect information

Missing the information

Other

Thank you for helping improve Cloudflare's documentation!