workers-sdk/packages/wrangler
ANT Bot 04eac7d89e
Version Packages (#12427)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
History 2026-02-10 09:18:40 +00:00
..
bin Hard fail Wrangler on Node.js < 20 (#9393) 2025-05-28 18:50:50 +00:00
e2e Drop node:process polyfill when v2 is available (#12377) 2026-02-05 22:40:46 +01:00
scripts Add Node.js 24 and 25 compatibility to the test suites for Miniflare, Wrangler, and vitest-pool-workers packages (#11858) 2026-01-12 10:08:24 +00:00
src Part 3️⃣ of removing CfWorkerInit["bindings"] (#12487) 2026-02-09 21:18:16 +00:00
templates [wrangler] Add User-Agent header to remote dev inspector WebSocket connections (#12463) 2026-02-09 11:33:56 +00:00
CHANGELOG.md Version Packages (#12427) 2026-02-10 09:18:40 +00:00
CONTRIBUTING.md Slightly Improve process for experimental features in wrangler (#11938) 2026-01-23 16:00:01 +00:00
eslint.config.mjs Use vitest#expect from the local context (#12426) 2026-02-05 14:11:15 +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 (#12427) 2026-02-10 09:18:40 +00:00
README.md refactor(wrangler): Update Wrangler README configuration example (#12299) 2026-01-30 10:07:34 +00:00
telemetry.md Improve autoconfig telemetry with granular event tracking (#12307) 2026-02-06 15:14:34 +00:00
tsconfig.emit.json Fix wrangler generated types to match runtime exports (#4161) 2023-10-12 17:11:39 +01:00
tsconfig.json Full autoconfig flow for some projects (#11164) 2025-11-05 12:24:45 +00:00
tsup.config.ts Extract a publishable @cloudflare/workers-utils package (#11097) 2025-10-28 14:29:35 +00:00
turbo.json Add E2E tests for MySQL Hyperdrives (#11779) 2026-02-04 09:33:19 +00:00
vitest.config.mts Support JSRPC for remote bindings (#10249) 2025-08-15 18:20:46 +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

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.