⛅️ wrangler

wrangler is a command line tool for building Cloudflare Workers.

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.

Wrangler System Requirements

We support running the Wrangler CLI with the Current, Active, and Maintenance versions of Node.js. Your Worker will always be executed in workerd, the open source Cloudflare Workers runtime.

Wrangler is only supported on macOS 13.5+, Windows 11, and Linux distros that support glib 2.35. This follows workerd's OS support policy.

Documentation

For the latest Wrangler documentation, click here.

To read more about Workers in general:

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.