wrangler

What is wrangler?

The wrangler npm package is a command-line tool for building, deploying, and managing Cloudflare Workers projects. It simplifies the process of working with Cloudflare's serverless platform, allowing developers to focus on writing code rather than managing infrastructure.

What are wrangler's main functionalities?

Creating a new Cloudflare Workers project

This command initializes a new Cloudflare Workers project in a directory named 'my-worker'. It sets up the necessary configuration files and project structure.

npx wrangler generate my-worker

Publishing a Cloudflare Worker

This command deploys your Cloudflare Worker to the Cloudflare network. It reads the configuration from the wrangler.toml file and uploads your code to Cloudflare.

npx wrangler publish

Previewing a Cloudflare Worker

This command allows you to preview your Cloudflare Worker in a browser before deploying it. It provides a temporary URL where you can test your worker.

npx wrangler preview

Managing environment variables

This command allows you to securely store environment variables for your Cloudflare Worker. You will be prompted to enter the value for the secret, which will then be encrypted and stored.

npx wrangler secret put MY_SECRET

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.

README

⛅️ wrangler

wrangler is a command line tool for building Cloudflare Workers.

[!WARNING]

Wrangler v2 is only receiving critical security updates. We recommend you migrate to Wrangler v3 if you can.

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 deploy it
npx wrangler deploy 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 --no-delegate-c3
# try it out
cd my-worker && npm run start
# and then deploy 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:

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

For more detailed information about configuration, refer to 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 deploy

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.