wrangler is a command line tool for building Cloudflare Workers.

[!WARNING]

Wrangler v2 is only receiving critical security updates. We recommend you migrate to Wrangler v3 if you can.

Quick Start

To get started quickly with a Hello World worker, run the command below:

npx wrangler init my-worker -y

For more info, visit our Getting Started guide.

Documentation

For the latest Wrangler documentation, click here.

To read more about Workers in general:

• Getting Started
• How Workers works
• Observability
• Platform

Configuration

Wrangler is configured via a wrangler.toml or wrangler.json file in the project root. An example configuration generated by npx wrangler init or npx create cloudflare is as follows:

name = "my-worker"
main = "./src/index.ts"
compatibility_date = "YYYY-MM-DD"

For more detailed information about configuration, refer to the documentation.

Commands

Workers

wrangler dev

Start a local development server, with live reloading and devtools.

wrangler deploy

Publish the given script to Cloudflare's global network.

For more commands and options, refer to the documentation.

Pages

wrangler pages dev [directory]

Serves a static build asset directory.

Builds and runs functions from a ./functions directory or uses a _worker.js file inside the static build asset directory.

For more commands and options, refer to the documentation or run wrangler pages dev --help.