wrangler

⛅️ wrangler

This package is for wrangler v2.x, released first in May 2022. If you're looking for v1.x of the @cloudflare/wrangler package, visit https://www.npmjs.com/package/@cloudflare/wrangler / https://github.com/cloudflare/wrangler-legacy.

wrangler is a command line tool for building Cloudflare Workers.

Quick Start

# Make a javascript file
echo "export default { fetch() { return new Response('hello world') } }" > index.js
# try it out
npx wrangler dev index.js
# and then publish it
npx wrangler publish index.js --name my-worker
# visit https://my-worker.<your workers subdomain>.workers.dev

Create a Project

# Generate a new project
npx wrangler init my-worker
# try it out
cd my-worker && npm run start
# and then publish it
npm run deploy

Installation:

$ npm install wrangler --save-dev

Configuration:

Wrangler is configured via a wrangler.toml file in the project root. When utilizing the wrangler init command, a wrangler.toml file will be created for you.

example:

main = "./src/index.ts" # init w/ TypeScript
name = "my-worker"
compatibility_date = "YYY-MM-DD"

for more detailed information about configuration, see the documentation

Commands

wrangler init [name]

Creates a Worker project. For details on configuration keys and values, refer to the documentation.

wrangler dev

Start a local development server, with live reloading and devtools.

wrangler publish

Publish the given script to the worldwide Cloudflare network.

For more commands and options, refer to the documentation.

Pages

wrangler pages dev [directory] [-- command]

Either serves a static build asset directory, or proxies itself in front of a command.

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.

Documentation

For the latest Wrangler documentation, click here.

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.