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.

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:

• Getting Started
• How Workers works
• Observability
• Platform

Configuration

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

{
	"$schema": "node_modules/wrangler/config-schema.json",
	"name": "my-worker",
	"main": "./src/index.ts",
	"compatibility_date": "YYYY-MM-DD",
}

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

Commands

The wrangler CLI offers various commands, the most popular being:

• wrangler dev to start a local development server, with live reloading and devtools.

• wrangler deploy to deploy a Worker to the Cloudflare's global network.

There are many more commands and options available, for a full list refer to the official Cloudflare documentation.

Source: packages/wrangler/README.md