mcpField
C
Cloudflare Wrangler

Cloudflare Wrangler

OfficialFeatured
developers.cloudflare.comCloud & DevOps4.7kwranglerUpdated today
RepositoryVisit website

About Cloudflare Wrangler

Wrangler is the official Cloudflare CLI for building and deploying Workers, D1, R2, KV, Queues, and Workflows. Developers can run npx wrangler dev to test locally, npx wrangler deploy to push to Cloudflare's global edge network, and tail production logs with wrangler tail.

Key features

  1. 01Develop and debug Cloudflare Workers applications locally
  2. 02Manage storage bindings including KV, D1, R2, and Queues
  3. 03Deploy to Cloudflare's global edge network and monitor logs

Use cases

  1. 01Build serverless edge functions and global APIs
  2. 02Create services powered by databases, object storage, and message queues
  3. 03Monitor and debug production Workers applications in real time

Install

Pick your OS or package manager and run the command in a terminal.

$
npm install -D wrangler

Once installed, runwrangler --versionto confirm it works.

Example commands

Common commands in the order you’d use them.

01
npx wrangler login
02
npx wrangler dev
03
npx wrangler deploy

Details

From the project README

Cloudflare Workers SDK

workers-logo
Cloudflare Workers let you deploy serverless code instantly across the globe for exceptional performance, reliability, and scale.

Contribute · Submit an Issue · Join Discord

Wrangler on npm   Discord conversation   X conversation

Quick Start

To get started quickly with a new project, run the command below:

npm create cloudflare@latest
# or
pnpm create cloudflare@latest
# or
yarn create cloudflare@latest

For more info, visit our Getting Started guide.

Documentation

Visit the official Workers documentation here.

Directory

PackageDescriptionLinks
wranglerA command line tool for building Cloudflare Workers.Docs
create-cloudflare (C3)A CLI for creating and deploying new applications to Cloudflare.Docs
miniflareA simulator for developing and testing Cloudflare Workers, powered by workerdDocs
chrome-devtools-patchesCloudflare's fork of Chrome DevTools for inspecting your local or remote Workers
pages-sharedUsed internally to power Wrangler and Cloudflare Pages. It contains all the code that is shared between these clients.

Beta releases

Beta releases are generated by the pkg.pr.new tool and are updated on every commit pushed to the main branch.

Warning

These beta releases get updated over time, so they are ill suited to be used as stable versions for a project (and the proper npm released should be used instead). These should be used only for quick testing of not yet released features/fixes.

Available beta releases are listed below.

create-cloudflare

npm i https://pkg.pr.new/create-cloudflare@main

@cloudflare/kv-asset-handler

npm i https://pkg.pr.new/@cloudflare/kv-asset-handler@main

miniflare

npm i https://pkg.pr.new/miniflare@main

@cloudflare/pages-shared

npm i https://pkg.pr.new/@cloudflare/pages-shared@main

@cloudflare/unenv-preset

npm i https://pkg.pr.new/@cloudflare/unenv-preset@main

@cloudflare/vite-plugin

npm i https://pkg.pr.new/@cloudflare/vite-plugin@main

@cloudflare/vitest-plugin

npm i https://pkg.pr.new/@cloudflare/vitest-plugin@main

@cloudflare/workers-editor-shared

npm i https://pkg.pr.new/@cloudflare/workers-editor-shared@main

wrangler

npm i https://pkg.pr.new/wrangler@main

Contributing

We welcome new contributors! Refer to the CONTRIBUTING.md guide for details.

Community

Join us in the official Cloudflare Discord to meet other developers, ask questions, or learn more in general.

Links

Comments

Markdown supported