CheatPress

Wrangler Cloudflare Workers CLI

Version 4.x · source

Wrangler, Postcard, light preview Light · Postcard 102 × 152 mm · PDF Wrangler, Postcard, dark preview Dark · Postcard 102 × 152 mm · PDF Wrangler, Postcard, ink saver preview Ink saver · Postcard 102 × 152 mm · PDF
Wrangler, A5, light preview Light · A5 148 × 210 mm · PDF Wrangler, A5, dark preview Dark · A5 148 × 210 mm · PDF Wrangler, A5, ink saver preview Ink saver · A5 148 × 210 mm · PDF
Wrangler, A4, light preview Light · A4 210 × 297 mm · PDF Wrangler, A4, dark preview Dark · A4 210 × 297 mm · PDF Wrangler, A4, ink saver preview Ink saver · A4 210 × 297 mm · PDF
Wrangler, A4 landscape, light preview Light · A4 landscape 297 × 210 mm · PDF Wrangler, A4 landscape, dark preview Dark · A4 landscape 297 × 210 mm · PDF Wrangler, A4 landscape, ink saver preview Ink saver · A4 landscape 297 × 210 mm · PDF
Wrangler, A3, light preview Light · A3 297 × 420 mm · PDF Wrangler, A3, dark preview Dark · A3 297 × 420 mm · PDF Wrangler, A3, ink saver preview Ink saver · A3 297 × 420 mm · PDF
Wrangler, A3 landscape, light preview Light · A3 landscape 420 × 297 mm · PDF Wrangler, A3 landscape, dark preview Dark · A3 landscape 420 × 297 mm · PDF Wrangler, A3 landscape, ink saver preview Ink saver · A3 landscape 420 × 297 mm · PDF
Wrangler, Letter, light preview Light · Letter 8.5 × 11 in · PDF Wrangler, Letter, dark preview Dark · Letter 8.5 × 11 in · PDF Wrangler, Letter, ink saver preview Ink saver · Letter 8.5 × 11 in · PDF
Wrangler, Tabloid, light preview Light · Tabloid 11 × 17 in · PDF Wrangler, Tabloid, dark preview Dark · Tabloid 11 × 17 in · PDF Wrangler, Tabloid, ink saver preview Ink saver · Tabloid 11 × 17 in · PDF

Start here

npm create cloudflare@latest
Scaffold a Worker
wrangler login
Sign in to Cloudflare
wrangler dev
Run locally
wrangler deploy
Publish to the edge
wrangler tail
Stream live logs
wrangler secret put <KEY>
Store a secret
wrangler d1 migrations apply <db>
Update the database
wrangler rollback
Undo a bad deploy

Concepts

  1. Code + config src/ and wrangler.jsonc
  2. Local preview localhost:8787
  3. Cloudflare edge live Worker
  4. Live logs debug and watch

Account

wrangler login
Sign in through the browser
wrangler whoami
Show the signed-in account
wrangler logout
Remove stored credentials

Project

npm create cloudflare@latest
Create a new Worker project
wrangler init [<name>]
Set up Wrangler in a folder
wrangler types
Generate types for your bindings
Writes worker-configuration.d.ts; rerun after config changes

Develop

wrangler dev
Run the Worker locally
wrangler dev --port <n>
Use another local port
wrangler dev --remote
Run against remote resources
wrangler dev --local
Keep all bindings local

Deploy

wrangler deploy
Publish the Worker
wrangler deploy --env <name>
Deploy an environment
wrangler deploy --dry-run --outdir <dir>
Build without publishing
wrangler deploy --keep-vars
Keep dashboard-set variables
wrangler delete [<name>]
Remove a Worker

Logs

wrangler tail
Stream live logs
wrangler tail --format pretty
Human-readable log lines
wrangler tail --status error
Only failed requests
wrangler tail --search <text>
Filter by log text

Secrets

wrangler secret put <KEY>
Add or update a secret
wrangler secret list
List secret names
wrangler secret delete <KEY>
Remove a secret
wrangler secret bulk <file>
Set many secrets from JSON or .env

Versions

wrangler versions upload
Upload without going live
wrangler versions list
List recent versions
wrangler versions deploy <id>@<pct>
Split traffic between versions
wrangler deployments list
Show deployment history
wrangler rollback [<id>]
Return to an earlier version
Without an id it goes back one version

KV

wrangler kv namespace create <name>
Create a namespace
wrangler kv namespace list
List namespaces
wrangler kv key put <key> <value> --binding <b>
Write a key
wrangler kv key get <key> --binding <b>
Read a key
wrangler kv key list --binding <b>
List keys
wrangler kv key delete <key> --binding <b>
Delete a key
wrangler kv bulk put <file.json> --binding <b>
Write many keys

R2

wrangler r2 bucket create <name>
Create a bucket
wrangler r2 bucket list
List buckets
wrangler r2 bucket delete <name>
Delete a bucket
wrangler r2 object put <bucket>/<key> --file <path>
Upload an object
wrangler r2 object get <bucket>/<key> --file <path>
Download an object
wrangler r2 object delete <bucket>/<key>
Delete an object

D1

wrangler d1 create <name>
Create a database
wrangler d1 list
List databases
wrangler d1 execute <db> --command "<sql>"
Run one SQL statement
wrangler d1 execute <db> --file <file.sql>
Run a SQL file
wrangler d1 migrations create <db> <name>
Add a migration file
wrangler d1 migrations apply <db>
Apply pending migrations
wrangler d1 migrations list <db>
Show unapplied migrations
wrangler d1 export <db> --output <file.sql>
Dump to a SQL file
wrangler d1 time-travel restore <db> --timestamp <t>
Restore to a past moment

Config

Config fields
Field Purpose
name Worker name
main Entry file
compatibility_date Runtime behaviour date
compatibility_flags Opt-in runtime features
vars Plain variables
kv_namespaces KV bindings
r2_buckets R2 bindings
d1_databases D1 bindings
routes Custom domains and routes
assets Static asset directory
observability Logs and traces
env.<name> Per-environment overrides

Recipes

First deploy
npm create cloudflare@latest my-appcd my-appnpx wrangler devnpx wrangler deploy
Database from scratch
npx wrangler d1 create <db>npx wrangler d1 migrations create <db> initnpx wrangler d1 migrations apply <db> --localnpx wrangler d1 migrations apply <db> --remote
Gradual rollout
npx wrangler versions uploadnpx wrangler versions deploy <new>@10% <old>@90% -y# watch errors, then shift trafficnpx wrangler versions deploy <new>@100% -y
Add a secret and watch it work
npx wrangler secret put API_TOKENnpx wrangler tail --status error