> wrangler

$ wrangler pages deploy ./dist --project-name my-app --branch "$GITHUB_REF_NAME" --commit-hash "$GITHUB_SHA" --commit-message "$(git log -1 --pretty=%s)" --commit-dirty=true

Develop the full app locally with Functions

$ wrangler pages dev ./dist

Bind KV, D1, and R2 in local dev

$ wrangler pages dev ./dist --kv CACHE --d1 DB --r2 UPLOADS

Set compatibility date and nodejs_compat for dev

$ wrangler pages dev ./dist --compatibility-date 2024-09-23 --compatibility-flag nodejs_compat

Set and list production secrets

$ wrangler pages secret put DATABASE_URL --project-name my-app

Bulk-upload secrets from a file

$ wrangler pages secret bulk ./secrets.json --project-name my-app

Tail production logs and list deployments

$ wrangler pages deployment tail --project-name my-app

// secrets & env vars

8 commands

Set a production secret interactively

$ wrangler secret put API_KEY

Set a secret for a specific environment

$ wrangler secret put API_KEY --env production

Set a secret non-interactively from CI

$ echo -n "$SECRET_VALUE" | wrangler secret put API_KEY --env production

Bulk-upload many secrets from a file

$ wrangler secret bulk .env

List which secrets a Worker has

$ wrangler secret list --format pretty

Delete a stale secret

$ wrangler secret delete OLD_TOKEN --env production

Load secrets for local dev without deploying them

$ echo "API_KEY=local-dev-value" >> .dev.vars

Manage secrets for a specific config file

$ wrangler secret put DATABASE_URL -c ./workers/api/wrangler.jsonc --env production

// kv

10 commands

Create a KV namespace and wire it into config

$ wrangler kv namespace create SESSIONS

Create a preview namespace for local dev

$ wrangler kv namespace create SESSIONS --preview

List namespaces to recover a lost id

$ wrangler kv namespace list

Write a single key/value pair

$ wrangler kv key put KEY VALUE --binding=SESSIONS

Cache a value with a TTL or expiration

$ wrangler kv key put "cache:home" "$(cat page.html)" --binding=CACHE --ttl 3600

Read a value back to the terminal

$ wrangler kv key get KEY --binding=SESSIONS --text

List keys by prefix

$ wrangler kv key list --binding=SESSIONS --prefix "user:"

Seed the local KV store that dev uses

$ wrangler kv key put KEY VALUE --binding=CACHE --local

Bulk upload many pairs from a JSON file

$ wrangler kv bulk put ./data.json --binding=CACHE

Write to a specific environment's namespace

$ wrangler kv key put FEATURE_X on --binding=CONFIG --env production

// r2

10 commands

Create an R2 Bucket and Bind It to a Worker

$ wrangler r2 bucket create my-bucket

List Your Buckets and Inspect One

$ wrangler r2 bucket list

Upload a Local File to a Bucket

$ wrangler r2 object put my-bucket/images/logo.png --file=./logo.png --content-type=image/png --remote

Download an Object or Stream It to Stdout

$ wrangler r2 object get my-bucket/images/logo.png --file=./logo.png --remote

Delete an Object from a Bucket

$ wrangler r2 object delete my-bucket/images/logo.png --remote

Serve a Bucket Publicly Over a Custom Domain

$ wrangler r2 bucket dev-url enable my-bucket

Allow Browser Uploads by Setting a CORS Policy

$ wrangler r2 bucket cors set my-bucket --file=./cors.json

Auto-Expire Old Objects with a Lifecycle Rule

$ wrangler r2 bucket lifecycle add my-bucket

Trigger a Queue When Objects Change

$ wrangler r2 bucket notification create my-bucket --event-type object-create --queue my-queue

Develop Against Local vs. Remote R2 Storage

$ wrangler dev

// d1 & hyperdrive

11 commands

Create a D1 database and grab its binding

$ wrangler d1 create <name>

Run a one-off SQL query against local or remote

$ wrangler d1 execute <database> --command "SELECT * FROM users LIMIT 5" --local

Load a schema or seed SQL file into D1

$ wrangler d1 execute <database> --file ./schema.sql --remote

Create a new versioned migration

$ wrangler d1 migrations create <database> "add_users_table"

Apply migrations to the remote database

$ wrangler d1 migrations apply <database> --local

Check which migrations are still pending

$ wrangler d1 migrations list <database> --remote

Back up or export a D1 database to a .sql file

$ wrangler d1 export <name> --remote --output ./backup.sql

Restore a database to a point in time

$ wrangler d1 time-travel info <database>

Inspect D1 databases and their size

$ wrangler d1 list

Create a Hyperdrive config for Postgres

$ wrangler hyperdrive create <name> --connection-string="postgres://user:[email protected]:5432/postgres"

Tune Hyperdrive caching or rotate its credentials

$ wrangler hyperdrive list

// queues & cron

6 commands

Create a Queue for a Producer Worker

$ wrangler queues create <name>

Attach a Consumer Worker to a Queue

$ wrangler queues consumer add <queue-name> <script-name>

Schedule a Worker with a Cron Trigger

$ # wrangler.jsonc: "triggers": { "crons": ["0 */6 * * *"] }

Test a Cron Handler Locally

$ wrangler dev --test-scheduled

Pause and Purge a Queue During an Incident

$ wrangler queues pause-delivery <name>

Inspect a Queue's Backlog and Consumers

$ wrangler queues list

// logs & debug

6 commands

Tail Live Production Logs

$ wrangler tail

Watch Only Errored Invocations

$ wrangler tail my-worker --status error

Tail the Right Worker in a Multi-Environment Setup

$ wrangler tail -e production

Isolate One Request While Reproducing a Bug

$ wrangler tail --status error --method POST --search "checkout"

Capture Structured Logs and Pipe to jq

$ wrangler tail --format json | jq 'select(.outcome=="exception")'

Check What Version Is Live and Review History

$ wrangler deployments status