workers-sdk/packages/wrangler
ANT Bot 341bd13b22
Version Packages (#14237)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
History 2026-06-11 16:28:56 +01:00
..
bin [wrangler] Add cf-wrangler delegate entrypoint; remove @cloudflare/wrangler-bundler (#14184) 2026-06-10 14:34:32 +00:00
e2e [workers-auth] Make OAuth identity and token storage injectable for reuse by other CLIs (#14185) 2026-06-11 12:07:55 +01:00
scripts Bump rosie-skills from 0.7.6 to 0.8.1 and bundle it into the Wrangler output (#14125) 2026-06-01 12:20:34 +01:00
src Wrangler support for experimental new config (#14202) 2026-06-11 15:26:19 +01:00
templates Gate Network.enable on an attached DevTools client (#14243) 2026-06-11 13:25:41 +01:00
AGENTS.md [wrangler] Add cf-wrangler delegate entrypoint; remove @cloudflare/wrangler-bundler (#14184) 2026-06-10 14:34:32 +00:00
CHANGELOG.md Version Packages (#14237) 2026-06-11 16:28:56 +01:00
CONTRIBUTING.md Slightly Improve process for experimental features in wrangler (#11938) 2026-01-23 16:00:01 +00:00
import_meta_url.js proper login/refresh for all commands, and some cleanups 2021-11-14 10:14:08 +00:00
kv-asset-handler.js fix: resolve asset handler for --experimental-path (#1253) 2022-06-14 14:57:58 +01:00
package.json Version Packages (#14237) 2026-06-11 16:28:56 +01:00
README.md Simplify Commands section of wrangler readme (#12639) 2026-02-27 11:06:35 +00:00
telemetry.md Add telemetry for detecting whether AI coding agents have Cloudflare skills installed (#14009) 2026-05-26 14:50:54 +01:00
tsconfig.emit.json Fix wrangler generated types to match runtime exports (#4161) 2023-10-12 17:11:39 +01:00
tsconfig.experimental-config.json Wrangler support for experimental new config (#14202) 2026-06-11 15:26:19 +01:00
tsconfig.json Wrangler support for experimental new config (#14202) 2026-06-11 15:26:19 +01:00
tsdown.config.mts Wrangler support for experimental new config (#14202) 2026-06-11 15:26:19 +01:00
tsup.config.ts Wrangler support for experimental new config (#14202) 2026-06-11 15:26:19 +01:00
turbo.json feat(wrangler): Add a new wrangler preview command group for Worker Previews (#12983) 2026-04-09 18:09:32 +01:00
vitest.config.mts Enable require-description-when-disabling lint rule on the wrangler package (#14043) 2026-05-26 16:22:02 +01:00

⛅️ wrangler

npm GitHub contributors GitHub commit activity (branch) Discord

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.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.