wrangler

⛅️ 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:

• 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

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.

Similar packages

Other packages similar to wrangler

serverless

The Serverless Framework is a popular open-source framework for building and deploying serverless applications across various cloud providers, including AWS, Azure, and Google Cloud. It offers a broader range of integrations and features compared to wrangler, which is specific to Cloudflare Workers.

architect

Architect (or @architect) is an open-source framework for building and deploying serverless applications on AWS. It provides a simple and declarative way to define serverless infrastructure and focuses on developer productivity. Unlike wrangler, which is Cloudflare-specific, Architect is designed for AWS.

claudia

Claudia.js is a tool for deploying Node.js projects to AWS Lambda and API Gateway. It automates many of the deployment steps and simplifies the process of creating and managing serverless applications on AWS. Claudia.js is more AWS-centric, whereas wrangler is tailored for Cloudflare Workers.