workers-sdk/packages/wrangler
ANT Bot 2e6b4ab2b8
Version Packages (#12876)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
History 2026-03-16 11:47:50 +00:00
..
bin Hard fail Wrangler on Node.js < 20 (#9393) 2025-05-28 18:50:50 +00:00
e2e [wrangler] Deduplicate unenv-preset e2e tests and bump beforeAll timeout (#12863) 2026-03-13 12:46:33 +00: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 Fix autoconfig package installation always failing at workspace roots (#12676) 2026-03-15 23:00:18 +00:00
templates [miniflare/wrangler] Revert AI Search RPC workaround (#12691) 2026-03-02 12:25:33 +00:00
AGENTS.md Add hierarchical AGENTS.md knowledge base for key packages (#12641) 2026-02-23 15:17:25 +00:00
CHANGELOG.md Version Packages (#12876) 2026-03-16 11:47:50 +00:00
CONTRIBUTING.md Slightly Improve process for experimental features in wrangler (#11938) 2026-01-23 16:00:01 +00:00
eslint.config.mjs refactor: use ci-info for CI detection (#12504) 2026-02-10 18:02:22 +01: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 (#12876) 2026-03-16 11:47:50 +00:00
README.md Simplify Commands section of wrangler readme (#12639) 2026-02-27 11:06:35 +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 Use capnweb native ReadableStream support for remote Media bindings (#12582) 2026-02-23 14:22:30 +00:00
turbo.json [workers-playground] Migrate from Cloudflare Pages to Cloudflare Workers (#12655) 2026-03-11 13:11:10 +00:00
vitest.config.mts chore(wrangler): change snapshot format (#12524) 2026-02-11 07:06:46 +00: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.