Commands

Wrangler offers a number of commands to manage your Cloudflare Workers.

• docs - Open this page in your default browser.
• init - Create a new project from a variety of web frameworks and templates.
• containers - Interact with Containers.
• d1 - Interact with D1.
• vectorize - Interact with Vectorize indexes.
• hyperdrive - Manage your Hyperdrives.
• deploy - Deploy your Worker to Cloudflare.
• dev - Start a local server for developing your Worker.
• delete - Delete your Worker from Cloudflare.
• kv namespace - Manage Workers KV namespaces.
• kv key - Manage key-value pairs within a Workers KV namespace.
• kv bulk - Manage multiple key-value pairs within a Workers KV namespace in batches.
• r2 bucket - Manage Workers R2 buckets.
• r2 object - Manage Workers R2 objects.
• r2 sql - Query tables in R2 Data Catalog with R2 SQL.
• secret - Manage the secret variables for a Worker.
• secret bulk - Manage multiple secret variables for a Worker.
• secrets-store secret - Manage account secrets within a secrets store.
• secrets-store store - Manage your store within secrets store.
• workflows - Manage and configure Workflows.
• tail - Start a session to livestream logs from a deployed Worker.
• pages - Configure Cloudflare Pages.
• pipelines - Configure Cloudflare Pipelines.
• queues - Configure Workers Queues.
• login - Authorize Wrangler with your Cloudflare account using OAuth.
• logout - Remove Wrangler's authorization for accessing your account.
• whoami - Retrieve your user information and test your authentication configuration.
• versions - Retrieve details for recent versions.
• deployments - Retrieve details for recent deployments.
• rollback - Rollback to a recent deployment.
• dispatch-namespace - Interact with a dispatch namespace.
• mtls-certificate - Manage certificates used for mTLS connections.
• cert - Manage certificates used for mTLS and Certificate Authority (CA) chain connections.
• types - Generate types from bindings and module rules in configuration.
• telemetry - Configure whether Wrangler can collect anonymous usage data.
• check - Validate your Worker.

Note

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

---

How to run Wrangler commands

This page provides a reference for Wrangler commands.

wrangler <COMMAND> <SUBCOMMAND> [PARAMETERS] [OPTIONS]

Since Cloudflare recommends installing Wrangler locally in your project(rather than globally), the way to run Wrangler will depend on your specific setup and package manager.

npm

npx wrangler <COMMAND> <SUBCOMMAND> [PARAMETERS] [OPTIONS]

yarn

yarn wrangler <COMMAND> <SUBCOMMAND> [PARAMETERS] [OPTIONS]

pnpm

pnpm wrangler <COMMAND> <SUBCOMMAND> [PARAMETERS] [OPTIONS]

You can add Wrangler commands that you use often as scripts in your project's package.json file:

{
  ...
  "scripts": {
    "deploy": "wrangler deploy",
    "dev": "wrangler dev"
  }
  ...
}

You can then run them using your package manager of choice:

npm

npm run deploy

yarn

yarn run deploy

pnpm

pnpm run deploy

---

docs

Open the Cloudflare developer documentation in your default browser.

npm

npx wrangler docs [SEARCH]

pnpm

pnpm wrangler docs [SEARCH]

yarn

yarn wrangler docs [SEARCH]

• [SEARCH] string

  Enter search terms (e.g. the wrangler command) you want to know more about

• --yes boolean alias: --y

  Takes you to the docs, even if search fails

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

---

init

Create a new project via the create-cloudflare-cli (C3) tool. A variety of web frameworks are available to choose from as well as templates. Dependencies are installed by default, with the option to deploy your project immediately.

wrangler init [<NAME>] [OPTIONS]

• NAME string optional (default: name of working directory)
  • The name of the Workers project. This is both the directory name and name property in the generated Wrangler configuration.
• --yes boolean optional
  • Answer yes to any prompts for new projects.
• --from-dash string optional
  • Fetch a Worker initialized from the dashboard. This is done by passing the flag and the Worker name. wrangler init --from-dash <WORKER_NAME>.
  • The --from-dash command will not automatically sync changes made to the dashboard after the command is used. Therefore, it is recommended that you continue using the CLI.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

---

containers

Interact with Cloudflare's Container Platform.

build

Build a Container image from a Dockerfile.

wrangler containers build [PATH] [OPTIONS]

• PATH string optional
  • Path for the directory containing the Dockerfile to build.
• -t, --tag string required
  • Name and optionally a tag (format: "name:tag").
• --path-to-docker string optional
  • Path to your docker binary if it's not on $PATH.
  • Default: "docker"
• -p, --push boolean optional
  • Push the built image to Cloudflare's managed registry.
  • Default: false

delete

Delete a Container (application).

wrangler containers delete <CONTAINER_ID> [OPTIONS]

• CONTAINER_ID string required
  • The ID of the Container to delete.

images

Perform operations on images in your containers registry.

images list

List images in your containers registry.

wrangler containers images list [OPTIONS]

• --filter string optional
  • Regex to filter results.
• --json boolean optional
  • Return output as clean JSON.
  • Default: false

images delete

Remove an image from your containers registry.

wrangler containers images delete [IMAGE] [OPTIONS]

• IMAGE string required
  • Image to delete of the form IMAGE:TAG

info

Get information about a specific Container, including top-level details and a list of instances.

wrangler containers info <CONTAINER_ID> [OPTIONS]

• CONTAINER_ID string required
  • The ID of the Container to get information about.

list

List the Containers in your account.

wrangler containers list [OPTIONS]

push

Push a tagged image to a Cloudflare managed registry, which is automatically integrated with your account.

wrangler containers push [TAG] [OPTIONS]

• TAG string required
  • The name and tag of the container image to push.
• --path-to-docker string optional
  • Path to your docker binary if it's not on $PATH.
  • Default: "docker"

d1

Interact with Cloudflare's D1 service.

create

Creates a new D1 database, and provides the binding and UUID that you will put in your Wrangler file.

wrangler d1 create <DATABASE_NAME> [OPTIONS]

• DATABASE_NAME string required
  • The name of the new D1 database.
• --location string optional
  • Provide an optional location hint for your database leader.
  • Available options include weur (Western Europe), eeur (Eastern Europe), apac (Asia Pacific), oc (Oceania), wnam (Western North America), and enam (Eastern North America).

info

Get information about a D1 database, including the current database size and state.

wrangler d1 info <DATABASE_NAME> [OPTIONS]

• DATABASE_NAME string required
  • The name of the D1 database to get information about.
• --json boolean optional
  • Return output as JSON rather than a table.

list

List all D1 databases in your account.

wrangler d1 list [OPTIONS]

• --json boolean optional
  • Return output as JSON rather than a table.

delete

Delete a D1 database.

wrangler d1 delete <DATABASE_NAME> [OPTIONS]

• DATABASE_NAME string required
  • The name of the D1 database to delete.
• -y, --skip-confirmation boolean optional
  • Skip deletion confirmation prompt.

execute

Execute a query on a D1 database.

wrangler d1 execute <DATABASE_NAME> [OPTIONS]

Note

You must provide either --command or --file for this command to run successfully.

• DATABASE_NAME string required
  • The name of the D1 database to execute a query on.
• --command string optional
  • The SQL query you wish to execute.
• --file string optional
  • Path to the SQL file you wish to execute.
• -y, --yes boolean optional
  • Answer yes to any prompts.
• --local boolean (default: true) optional
  • Execute commands/files against a local database for use with wrangler dev.
• --remote boolean (default: false) optional
  • Execute commands/files against a remote D1 database for use with remote bindings or your deployed Worker.
• --persist-to string optional
  • Specify directory to use for local persistence (for use in combination with --local).
• --json boolean optional
  • Return output as JSON rather than a table.
• --preview boolean optional
  • Execute commands/files against a preview D1 database (as defined by preview_database_id in the Wrangler configuration file).

export

Export a D1 database or table's schema and/or content to a .sql file.

wrangler d1 export <DATABASE_NAME> [OPTIONS]

• DATABASE_NAME string required
  • The name of the D1 database to export.
• --local boolean (default: true) optional
  • Export from a local database for use with wrangler dev.
• --remote boolean (default: false) optional
  • Export from a remote D1 database.
• --output string required
  • Path to the SQL file for your export.
• --table string optional
  • The name of the table within a D1 database to export.
• --no-data boolean (default: false) optional
  • Controls whether export SQL file contains database data. Note that --no-data=true is not recommended due to a known wrangler limitation that intreprets the value as false.
• --no-schema boolean (default: false) optional
  • Controls whether export SQL file contains database schema. Note that --no-schema=true is not recommended due to a known wrangler limitation that intreprets the value as false.

time-travel restore

Restore a database to a specific point-in-time using Time Travel.

wrangler d1 time-travel restore <DATABASE_NAME> [OPTIONS]

• DATABASE_NAME string required
  • The name of the D1 database to execute a query on.
• --bookmark string optional
  • A D1 bookmark representing the state of a database at a specific point in time.
• --timestamp string optional
  • A UNIX timestamp or JavaScript date-time string within the last 30 days.
• --json boolean optional
  • Return output as JSON rather than a table.

time-travel info

Inspect the current state of a database for a specific point-in-time using Time Travel.

wrangler d1 time-travel info <DATABASE_NAME> [OPTIONS]

• DATABASE_NAME string required
  • The name of the D1 database to execute a query on.
• --timestamp string optional
  • A UNIX timestamp or JavaScript date-time string within the last 30 days.
• --json bboolean optional
  • Return output as JSON rather than a table.

migrations create

Create a new migration.

This will generate a new versioned file inside the migrations folder. Name your migration file as a description of your change. This will make it easier for you to find your migration in the migrations folder. An example filename looks like:

0000_create_user_table.sql

The filename will include a version number and the migration name you specify below.

wrangler d1 migrations create <DATABASE_NAME> <MIGRATION_NAME>

• DATABASE_NAME string required
  • The name of the D1 database you wish to create a migration for.
• MIGRATION_NAME string required
  • A descriptive name for the migration you wish to create.

migrations list

View a list of unapplied migration files.

wrangler d1 migrations list <DATABASE_NAME> [OPTIONS]

• DATABASE_NAME string required
  • The name of the D1 database you wish to list unapplied migrations for.
• --local boolean optional
  • Show the list of unapplied migration files on your locally persisted D1 database.
• --remote boolean (default: false) optional
  • Show the list of unapplied migration files on your remote D1 database.
• --persist-to string optional
  • Specify directory to use for local persistence (for use in combination with --local).
• --preview boolean optional
  • Show the list of unapplied migration files on your preview D1 database (as defined by preview_database_id in the Wrangler configuration file).

migrations apply

Apply any unapplied migrations.

This command will prompt you to confirm the migrations you are about to apply. Confirm that you would like to proceed. After, a backup will be captured.

The progress of each migration will be printed in the console.

When running the apply command in a CI/CD environment or another non-interactive command line, the confirmation step will be skipped, but the backup will still be captured.

If applying a migration results in an error, this migration will be rolled back, and the previous successful migration will remain applied.

wrangler d1 migrations apply <DATABASE_NAME> [OPTIONS]

• DATABASE_NAME string required
  • The name of the D1 database you wish to apply your migrations on.
• --env string optional
  • Specify which environment configuration to use for D1 binding
• --local boolean (default: true) optional
  • Execute any unapplied migrations on your locally persisted D1 database.
• --remote boolean (default: false) optional
  • Execute any unapplied migrations on your remote D1 database.
• --persist-to string optional
  • Specify directory to use for local persistence (for use in combination with --local).
• --preview boolean optional
  • Execute any unapplied migrations on your preview D1 database (as defined by preview_database_id in the Wrangler configuration file).

---

hyperdrive

Manage Hyperdrive database configurations.

hyperdrive create

Create a Hyperdrive config

npm

npx wrangler hyperdrive create [NAME]

pnpm

pnpm wrangler hyperdrive create [NAME]

yarn

yarn wrangler hyperdrive create [NAME]

• [NAME] string required

  The name of the Hyperdrive config

• --connection-string string

  The connection string for the database you want Hyperdrive to connect to - ex: protocol://user:password@host:port/database

• --origin-host string alias: --host

  The host of the origin database

• --origin-port number alias: --port

  The port number of the origin database

• --origin-scheme string alias: --scheme default: postgresql

  The scheme used to connect to the origin database

• --database string

  The name of the database within the origin database

• --origin-user string alias: --user

  The username used to connect to the origin database

• --origin-password string alias: --password

  The password used to connect to the origin database

• --access-client-id string

  The Client ID of the Access token to use when connecting to the origin database

• --access-client-secret string

  The Client Secret of the Access token to use when connecting to the origin database

• --caching-disabled boolean

  Disables the caching of SQL responses

• --max-age number

  Specifies max duration for which items should persist in the cache, cannot be set when caching is disabled

• --swr number

  Indicates the number of seconds cache may serve the response after it becomes stale, cannot be set when caching is disabled

• --ca-certificate-id string alias: --ca-certificate-uuid

  Sets custom CA certificate when connecting to origin database. Must be valid UUID of already uploaded CA certificate.

• --mtls-certificate-id string alias: --mtls-certificate-uuid

  Sets custom mTLS client certificates when connecting to origin database. Must be valid UUID of already uploaded public/private key certificates.

• --sslmode string

  Sets CA sslmode for connecting to database.

• --origin-connection-limit number

  The (soft) maximum number of connections that Hyperdrive may establish to the origin database

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

hyperdrive delete

Delete a Hyperdrive config

npm

npx wrangler hyperdrive delete [ID]

pnpm

pnpm wrangler hyperdrive delete [ID]

yarn

yarn wrangler hyperdrive delete [ID]

• [ID] string required

  The ID of the Hyperdrive config

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

hyperdrive get

Get a Hyperdrive config

npm

npx wrangler hyperdrive get [ID]

pnpm

pnpm wrangler hyperdrive get [ID]

yarn

yarn wrangler hyperdrive get [ID]

• [ID] string required

  The ID of the Hyperdrive config

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

hyperdrive list

List Hyperdrive configs

npm

npx wrangler hyperdrive list

pnpm

pnpm wrangler hyperdrive list

yarn

yarn wrangler hyperdrive list

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

hyperdrive update

Update a Hyperdrive config

npm

npx wrangler hyperdrive update [ID]

pnpm

pnpm wrangler hyperdrive update [ID]

yarn

yarn wrangler hyperdrive update [ID]

• [ID] string required

  The ID of the Hyperdrive config

• --name string

  Give your config a new name

• --connection-string string

  The connection string for the database you want Hyperdrive to connect to - ex: protocol://user:password@host:port/database

• --origin-host string alias: --host

  The host of the origin database

• --origin-port number alias: --port

  The port number of the origin database

• --origin-scheme string alias: --scheme

  The scheme used to connect to the origin database

• --database string

  The name of the database within the origin database

• --origin-user string alias: --user

  The username used to connect to the origin database

• --origin-password string alias: --password

  The password used to connect to the origin database

• --access-client-id string

  The Client ID of the Access token to use when connecting to the origin database

• --access-client-secret string

  The Client Secret of the Access token to use when connecting to the origin database

• --caching-disabled boolean

  Disables the caching of SQL responses

• --max-age number

  Specifies max duration for which items should persist in the cache, cannot be set when caching is disabled

• --swr number

  Indicates the number of seconds cache may serve the response after it becomes stale, cannot be set when caching is disabled

• --ca-certificate-id string alias: --ca-certificate-uuid

  Sets custom CA certificate when connecting to origin database. Must be valid UUID of already uploaded CA certificate.

• --mtls-certificate-id string alias: --mtls-certificate-uuid

  Sets custom mTLS client certificates when connecting to origin database. Must be valid UUID of already uploaded public/private key certificates.

• --sslmode string

  Sets CA sslmode for connecting to database.

• --origin-connection-limit number

  The (soft) maximum number of connections that Hyperdrive may establish to the origin database

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

---

vectorize

Interact with a Vectorize vector database.

vectorize create

Create a Vectorize index

npm

npx wrangler vectorize create [NAME]

pnpm

pnpm wrangler vectorize create [NAME]

yarn

yarn wrangler vectorize create [NAME]

• [NAME] string required

  The name of the Vectorize index to create (must be unique).

• --dimensions number

  The dimension size to configure this index for, based on the output dimensions of your ML model.

• --metric string

  The distance metric to use for searching within the index.

• --preset string

  The name of an preset representing an embeddings model: Vectorize will configure the dimensions and distance metric for you when provided.

• --description string

  An optional description for this index.

• --json boolean default: false

  Return output as clean JSON

• --deprecated-v1 boolean default: false

  Create a deprecated Vectorize V1 index. This is not recommended and indexes created with this option need all other Vectorize operations to have this option enabled.

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

vectorize delete

Delete a Vectorize index

npm

npx wrangler vectorize delete [NAME]

pnpm

pnpm wrangler vectorize delete [NAME]

yarn

yarn wrangler vectorize delete [NAME]

• [NAME] string required

  The name of the Vectorize index

• --force boolean alias: --y default: false

  Skip confirmation

• --deprecated-v1 boolean default: false

  Delete a deprecated Vectorize V1 index.

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

vectorize get

Get a Vectorize index by name

npm

npx wrangler vectorize get [NAME]

pnpm

pnpm wrangler vectorize get [NAME]

yarn

yarn wrangler vectorize get [NAME]

• [NAME] string required

  The name of the Vectorize index.

• --json boolean default: false

  Return output as clean JSON

• --deprecated-v1 boolean default: false

  Fetch a deprecated V1 Vectorize index. This must be enabled if the index was created with V1 option.

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

vectorize list

List your Vectorize indexes

npm

npx wrangler vectorize list

pnpm

pnpm wrangler vectorize list

yarn

yarn wrangler vectorize list

• --json boolean default: false

  Return output as clean JSON

• --deprecated-v1 boolean default: false

  List deprecated Vectorize V1 indexes for your account.

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

vectorize list-vectors

List vector identifiers in a Vectorize index

npm

npx wrangler vectorize list-vectors [NAME]

pnpm

pnpm wrangler vectorize list-vectors [NAME]

yarn

yarn wrangler vectorize list-vectors [NAME]

• [NAME] string required

  The name of the Vectorize index

• --count number

  Maximum number of vectors to return (1-1000)

• --cursor string

  Cursor for pagination to get the next page of results

• --json boolean default: false

  Return output as clean JSON

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

vectorize query

Query a Vectorize index

npm

npx wrangler vectorize query [NAME]

pnpm

pnpm wrangler vectorize query [NAME]

yarn

yarn wrangler vectorize query [NAME]

• [NAME] string required

  The name of the Vectorize index

• --vector number

  Vector to query the Vectorize Index

• --vector-id string

  Identifier for a vector in the index against which the index should be queried

• --top-k number default: 5

  The number of results (nearest neighbors) to return

• --return-values boolean default: false

  Specify if the vector values should be included in the results

• --return-metadata string default: none

  Specify if the vector metadata should be included in the results

• --namespace string

  Filter the query results based on this namespace

• --filter string

  Filter the query results based on this metadata filter.

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

vectorize insert

Insert vectors into a Vectorize index

npm

npx wrangler vectorize insert [NAME]

pnpm

pnpm wrangler vectorize insert [NAME]

yarn

yarn wrangler vectorize insert [NAME]

• [NAME] string required

  The name of the Vectorize index.

• --file string required

  A file containing line separated json (ndjson) vector objects.

• --batch-size number default: 1000

  Number of vector records to include when sending to the Cloudflare API.

• --json boolean default: false

  return output as clean JSON

• --deprecated-v1 boolean default: false

  Insert into a deprecated V1 Vectorize index. This must be enabled if the index was created with the V1 option.

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

vectorize upsert

Upsert vectors into a Vectorize index

npm

npx wrangler vectorize upsert [NAME]

pnpm

pnpm wrangler vectorize upsert [NAME]

yarn

yarn wrangler vectorize upsert [NAME]

• [NAME] string required

  The name of the Vectorize index.

• --file string required

  A file containing line separated json (ndjson) vector objects.

• --batch-size number default: 5000

  Number of vector records to include in a single upsert batch when sending to the Cloudflare API.

• --json boolean default: false

  return output as clean JSON

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

vectorize get-vectors

Get vectors from a Vectorize index

npm

npx wrangler vectorize get-vectors [NAME]

pnpm

pnpm wrangler vectorize get-vectors [NAME]

yarn

yarn wrangler vectorize get-vectors [NAME]

• [NAME] string required

  The name of the Vectorize index.

• --ids string required

  Vector identifiers to be fetched from the Vectorize Index. Example: --ids a 'b' 1 '2'

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

vectorize delete-vectors

Delete vectors in a Vectorize index

npm

npx wrangler vectorize delete-vectors [NAME]

pnpm

pnpm wrangler vectorize delete-vectors [NAME]

yarn

yarn wrangler vectorize delete-vectors [NAME]

• [NAME] string required

  The name of the Vectorize index.

• --ids string required

  Vector identifiers to be deleted from the Vectorize Index. Example: --ids a 'b' 1 '2'

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

vectorize info

Get additional details about the index

npm

npx wrangler vectorize info [NAME]

pnpm

pnpm wrangler vectorize info [NAME]

yarn

yarn wrangler vectorize info [NAME]

• [NAME] string required

  The name of the Vectorize index.

• --json boolean default: false

  return output as clean JSON

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

vectorize create-metadata-index

Enable metadata filtering on the specified property

npm

npx wrangler vectorize create-metadata-index [NAME]

pnpm

pnpm wrangler vectorize create-metadata-index [NAME]

yarn

yarn wrangler vectorize create-metadata-index [NAME]

• [NAME] string required

  The name of the Vectorize index.

• --propertyName string required

  The name of the metadata property to index.

• --type string required

  The type of metadata property to index. Valid types are 'string', 'number' and 'boolean'.

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

vectorize list-metadata-index

List metadata properties on which metadata filtering is enabled

npm

npx wrangler vectorize list-metadata-index [NAME]

pnpm

pnpm wrangler vectorize list-metadata-index [NAME]

yarn

yarn wrangler vectorize list-metadata-index [NAME]

• [NAME] string required

  The name of the Vectorize index.

• --json boolean default: false

  return output as clean JSON

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

vectorize delete-metadata-index

Delete metadata indexes

npm

npx wrangler vectorize delete-metadata-index [NAME]

pnpm

pnpm wrangler vectorize delete-metadata-index [NAME]

yarn

yarn wrangler vectorize delete-metadata-index [NAME]

• [NAME] string required

  The name of the Vectorize index.

• --propertyName string required

  The name of the metadata property to index.

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

---

dev

Start a local server for developing your Worker.

wrangler dev [<SCRIPT>] [OPTIONS]

Note

None of the options for this command are required. Many of these options can be set in your Wrangler file. Refer to the Wrangler configuration documentation for more information.

• SCRIPT string
  • The path to an entry point for your Worker. Only required if your Wrangler configuration file does not include a main key (for example, main = "index.js").
• --name string optional
  • Name of the Worker.
• --config, -c string[] optional
  • Path(s) to Wrangler configuration file. If not provided, Wrangler will use the nearest config file based on your current working directory.
  • You can provide multiple configuration files to run multiple Workers in one dev session like this: wrangler dev -c ./wrangler.toml -c ../other-worker/wrangler.toml. The first config will be treated as the primary Worker, which will be exposed over HTTP. The remaining config files will only be accessible via a service binding from the primary Worker.
• --no-bundle boolean (default: false) optional
  • Skip Wrangler's build steps. Particularly useful when using custom builds. Refer to Bundling ↗ for more information.
• --env string optional
  • Perform on a specific environment.
• --compatibility-date string optional
  • A date in the form yyyy-mm-dd, which will be used to determine which version of the Workers runtime is used.
• --compatibility-flags, --compatibility-flag string[] optional
  • Flags to use for compatibility checks.
• --latest boolean (default: true) optional
  • Use the latest version of the Workers runtime.
• --ip string optional
  • IP address to listen on, defaults to localhost.
• --port number optional
  • Port to listen on.
• --inspector-port number optional
  • Port for devtools to connect to.
• --routes, --route string[] optional
  • Routes to upload.
  • For example: --route example.com/*.
• --host string optional
  • Host to forward requests to, defaults to the zone of project.
• --local-protocol 'http'|'https' (default: http) optional
  • Protocol to listen to requests on.
• --https-key-path string optional
  • Path to a custom certificate key.
• --https-cert-path string optional
  • Path to a custom certificate.
• --local-upstream string optional
  • Host to act as origin in local mode, defaults to dev.host or route.
• --assets string optional beta
  • Folder of static assets to be served. Replaces Workers Sites. Visit assets for more information.
• --site string optional deprecated, use `--assets`
  • Folder of static assets for Workers Sites.

    Warning

    Workers Sites is deprecated. Please use Workers Assets or Pages.

• --site-include string[] optional deprecated
  • Array of .gitignore-style patterns that match file or directory names from the sites directory. Only matched items will be uploaded.
• --site-exclude string[] optional deprecated
  • Array of .gitignore-style patterns that match file or directory names from the sites directory. Matched items will not be uploaded.
• --upstream-protocol 'http'|'https' (default: https) optional
  • Protocol to forward requests to host on.
• --var key:value\[] optional
  • Array of key:value pairs to inject as variables into your code. The value will always be passed as a string to your Worker.
  • For example, --var "git_hash:'$(git rev-parse HEAD)'" "test:123" makes the git_hash and test variables available in your Worker's env.
  • This flag is an alternative to defining vars in your Wrangler configuration file. If defined in both places, this flag's values will be used.
• --define key:value\[] optional
  • Array of key:value pairs to replace global identifiers in your code.
  • For example, --define "GIT_HASH:'$(git rev-parse HEAD)'" will replace all uses of GIT_HASH with the actual value at build time.
  • This flag is an alternative to defining define in your Wrangler configuration file. If defined in both places, this flag's values will be used.
• --tsconfig string optional
  • Path to a custom tsconfig.json file.
• --minify boolean optional
  • Minify the Worker.
• --persist-to string optional
  • Specify directory to use for local persistence.
• --remote boolean (default: false) optional
  • Develop against remote resources and data stored on Cloudflare's network.
• --test-scheduled boolean (default: false) optional
  • Exposes a /__scheduled fetch route which will trigger a scheduled event (Cron Trigger) for testing during development. To simulate different cron patterns, a cron query parameter can be passed in: /__scheduled?cron=*+*+*+*+* or /cdn-cgi/handler/scheduled?cron=*+*+*+*+*.
• --log-level 'debug'|'info'|'log'|'warn'|'error|'none' (default: log) optional
  • Specify Wrangler's logging level.
• --show-interactive-dev-session boolean (default: true if the terminal supports interactivity) optional
  • Show the interactive dev session.
• --alias Array<string>
  • Specify modules to alias using module aliasing.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

wrangler dev is a way to locally test your Worker while developing. With wrangler dev running, send HTTP requests to localhost:8787 and your Worker should execute as expected. You will also see console.log messages and exceptions appearing in your terminal.

---

deploy

Deploy your Worker to Cloudflare.

wrangler deploy [<PATH>] [OPTIONS]

Note

None of the options for this command are required. Also, many can be set in your Wrangler file. Refer to the Wrangler configuration documentation for more information.

• PATH string

  • A path specific what needs to be deployed, this can either be:

    • The path to an entry point for your Worker.

      • Only required if your Wrangler configuration file does not include a main key (for example, main = "index.js").

    • Or the path to an assets directory for the deployment of a static site.

      • Visit assets for more information.
      • This overrides the eventual assets configuration in your Wrangler configuration file.
      • This is equivalent to the --assets option listed below.
      • Note: this option currently only works only in interactive mode (so not in CI systems).

• --name string optional

  • Name of the Worker.

• --no-bundle boolean (default: false) optional

  • Skip Wrangler's build steps. Particularly useful when using custom builds. Refer to Bundling ↗ for more information.

• --env string optional

  • Perform on a specific environment.

    Note

    If you're using the Cloudflare Vite plugin, you select the environment at dev or build time via the CLOUDFLARE_ENV environment variable rather than the --env flag. Otherwise, environments are defined in your Worker config file as usual. For more detail on using environments with the Cloudflare Vite plugin, refer to the plugin documentation.

• --outdir string optional

  • Path to directory where Wrangler will write the bundled Worker files.

• --compatibility-date string optional

  • A date in the form yyyy-mm-dd, which will be used to determine which version of the Workers runtime is used.

• --compatibility-flags, --compatibility-flag string[] optional

  • Flags to use for compatibility checks.

• --latest boolean (default: true) optional

  • Use the latest version of the Workers runtime.

• --assets string optional beta

  • Folder of static assets to be served. Replaces Workers Sites. Visit assets for more information.

• --site string optional deprecated, use `--assets`

  • Folder of static assets for Workers Sites.

    Warning

    Workers Sites is deprecated. Please use Workers Assets or Pages.

• --site-include string[] optional deprecated

  • Array of .gitignore-style patterns that match file or directory names from the sites directory. Only matched items will be uploaded.

• --site-exclude string[] optional deprecated

  • Array of .gitignore-style patterns that match file or directory names from the sites directory. Matched items will not be uploaded.

• --var key:value\[] optional

  • Array of key:value pairs to inject as variables into your code. The value will always be passed as a string to your Worker.
  • For example, --var git_hash:$(git rev-parse HEAD) test:123 makes the git_hash and test variables available in your Worker's env.
  • This flag is an alternative to defining vars in your Wrangler configuration file. If defined in both places, this flag's values will be used.

• --define key:value\[] optional

  • Array of key:value pairs to replace global identifiers in your code.
  • For example, --define GIT_HASH:$(git rev-parse HEAD) will replace all uses of GIT_HASH with the actual value at build time.
  • This flag is an alternative to defining define in your Wrangler configuration file. If defined in both places, this flag's values will be used.

• --triggers, --schedule, --schedules string[] optional

  • Cron schedules to attach to the deployed Worker. Refer to Cron Trigger Examples.

• --routes, --route string[] optional

  • Routes where this Worker will be deployed.
  • For example: --route example.com/*.

• --tsconfig string optional

  • Path to a custom tsconfig.json file.

• --minify boolean optional

  • Minify the bundled Worker before deploying.

• --dry-run boolean (default: false) optional

  • Compile a project without actually deploying to live servers. Combined with --outdir, this is also useful for testing the output of npx wrangler deploy. It also gives developers a chance to upload our generated sourcemap to a service like Sentry, so that errors from the Worker can be mapped against source code, but before the service goes live.

• --keep-vars boolean (default: false) optional

  • It is recommended best practice to treat your Wrangler developer environment as a source of truth for your Worker configuration, and avoid making changes via the Cloudflare dashboard.
  • If you change your environment variables in the Cloudflare dashboard, Wrangler will override them the next time you deploy. If you want to disable this behaviour set keep-vars to true.
  • Secrets are never deleted by a deployment whether this flag is true or false.

• --dispatch-namespace string optional

  • Specify the Workers for Platforms dispatch namespace to upload this Worker to.

• --metafile string optional

  • Specify a file to write the build metadata from esbuild to. If flag is used without a path string, this defaults to bundle-meta.json inside the directory specified by --outdir. This can be useful for understanding the bundle size.

• --containers-rollout immediate | gradual optional

  • Specify the rollout strategy for Containers associated with the Worker. If set to immediate, 100% of container instances will be updated in one rollout step, overriding any configuration in rollout_step_percentage. Note that rollout_active_grace_period, if configured, still applies.
  • Defaults to gradual, where the default rollout is 10% then 100% of instances.

• --strict boolean (default: false) optional

  • Turns on strict mode for the deployment command, meaning that the command will be more defensive and prevent deployments which could introduce potential issues. In particular, this mode prevents deployments if the deployment would potentially override remote settings in non-interactive environments.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

---

delete

Delete your Worker and all associated Cloudflare developer platform resources.

wrangler delete [<SCRIPT>] [OPTIONS]

• SCRIPT string
  • The path to an entry point for your Worker. Only required if your Wrangler configuration file does not include a main key (for example, main = "index.js").
• --name string optional
  • Name of the Worker.
• --env string optional
  • Perform on a specific environment.
• --dry-run boolean (default: false) optional
  • Do not actually delete the Worker. This is useful for testing the output of wrangler delete.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

---

kv namespace

Manage Workers KV namespaces.

Note

The kv ... commands allow you to manage your Workers KV resources in the Cloudflare network. Learn more about using Workers KV with Wrangler in the Workers KV guide.

Warning

Since version 3.60.0, Wrangler supports the kv ... syntax. If you are using versions below 3.60.0, the command follows the kv:... syntax. Learn more about the deprecation of the kv:... syntax in the Wrangler commands for KV page.

kv namespace create

Create a new namespace

npm

npx wrangler kv namespace create [NAMESPACE]

pnpm

pnpm wrangler kv namespace create [NAMESPACE]

yarn

yarn wrangler kv namespace create [NAMESPACE]

• [NAMESPACE] string required

  The name of the new namespace

• --preview boolean

  Interact with a preview namespace

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

kv namespace list

Output a list of all KV namespaces associated with your account id

npm

npx wrangler kv namespace list

pnpm

pnpm wrangler kv namespace list

yarn

yarn wrangler kv namespace list

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

kv namespace delete

Delete a given namespace.

npm

npx wrangler kv namespace delete

pnpm

pnpm wrangler kv namespace delete

yarn

yarn wrangler kv namespace delete

• --binding string

  The binding name to the namespace to delete from

• --namespace-id string

  The id of the namespace to delete

• --preview boolean

  Interact with a preview namespace

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

kv namespace rename

Rename a KV namespace

npm

npx wrangler kv namespace rename [OLD-NAME]

pnpm

pnpm wrangler kv namespace rename [OLD-NAME]

yarn

yarn wrangler kv namespace rename [OLD-NAME]

• [OLD-NAME] string

  The current name (title) of the namespace to rename

• --namespace-id string

  The id of the namespace to rename

• --new-name string required

  The new name for the namespace

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

kv key

Manage key-value pairs within a Workers KV namespace.

Note

The kv ... commands allow you to manage your Workers KV resources in the Cloudflare network. Learn more about using Workers KV with Wrangler in the Workers KV guide.

Warning

Since version 3.60.0, Wrangler supports the kv ... syntax. If you are using versions below 3.60.0, the command follows the kv:... syntax. Learn more about the deprecation of the kv:... syntax in the Wrangler commands for KV page.

kv key put

Write a single key/value pair to the given namespace

npm

npx wrangler kv key put [KEY] [VALUE]

pnpm

pnpm wrangler kv key put [KEY] [VALUE]

yarn

yarn wrangler kv key put [KEY] [VALUE]

• [KEY] string required

  The key to write to

• [VALUE] string

  The value to write

• --binding string

  The binding name to the namespace to write to

• --namespace-id string

  The id of the namespace to write to

• --preview boolean

  Interact with a preview namespace

• --ttl number

  Time for which the entries should be visible

• --expiration number

  Time since the UNIX epoch after which the entry expires

• --metadata string

  Arbitrary JSON that is associated with a key

• --path string

  Read value from the file at a given path

• --local boolean

  Interact with local storage

• --remote boolean

  Interact with remote storage

• --persist-to string

  Directory for local persistence

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

kv key list

Output a list of all keys in a given namespace

npm

npx wrangler kv key list

pnpm

pnpm wrangler kv key list

yarn

yarn wrangler kv key list

• --binding string

  The binding name to the namespace to list

• --namespace-id string

  The id of the namespace to list

• --preview boolean default: false

  Interact with a preview namespace

• --prefix string

  A prefix to filter listed keys

• --local boolean

  Interact with local storage

• --remote boolean

  Interact with remote storage

• --persist-to string

  Directory for local persistence

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

kv key get

Read a single value by key from the given namespace

npm

npx wrangler kv key get [KEY]

pnpm

pnpm wrangler kv key get [KEY]

yarn

yarn wrangler kv key get [KEY]

• [KEY] string required

  The key value to get.

• --binding string

  The binding name to the namespace to get from

• --namespace-id string

  The id of the namespace to get from

• --preview boolean default: false

  Interact with a preview namespace

• --text boolean default: false

  Decode the returned value as a utf8 string

• --local boolean

  Interact with local storage

• --remote boolean

  Interact with remote storage

• --persist-to string

  Directory for local persistence

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

kv key delete

Remove a single key value pair from the given namespace

npm

npx wrangler kv key delete [KEY]

pnpm

pnpm wrangler kv key delete [KEY]

yarn

yarn wrangler kv key delete [KEY]

• [KEY] string required

  The key value to delete.

• --binding string

  The binding name to the namespace to delete from

• --namespace-id string

  The id of the namespace to delete from

• --preview boolean

  Interact with a preview namespace

• --local boolean

  Interact with local storage

• --remote boolean

  Interact with remote storage

• --persist-to string

  Directory for local persistence

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

kv bulk

Manage multiple key-value pairs within a Workers KV namespace in batches.

Note

The kv ... commands allow you to manage your Workers KV resources in the Cloudflare network. Learn more about using Workers KV with Wrangler in the Workers KV guide.

Warning

Since version 3.60.0, Wrangler supports the kv ... syntax. If you are using versions below 3.60.0, the command follows the kv:... syntax. Learn more about the deprecation of the kv:... syntax in the Wrangler commands for KV page.

kv bulk get

Gets multiple key-value pairs from a namespace

npm

npx wrangler kv bulk get [FILENAME]

pnpm

pnpm wrangler kv bulk get [FILENAME]

yarn

yarn wrangler kv bulk get [FILENAME]

• [FILENAME] string required

  The file containing the keys to get

• --binding string

  The binding name to the namespace to get from

• --namespace-id string

  The id of the namespace to get from

• --preview boolean

  Interact with a preview namespace

• --local boolean

  Interact with local storage

• --remote boolean

  Interact with remote storage

• --persist-to string

  Directory for local persistence

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

kv bulk put

Upload multiple key-value pairs to a namespace

npm

npx wrangler kv bulk put [FILENAME]

pnpm

pnpm wrangler kv bulk put [FILENAME]

yarn

yarn wrangler kv bulk put [FILENAME]

• [FILENAME] string required

  The file containing the key/value pairs to write

• --binding string

  The binding name to the namespace to write to

• --namespace-id string

  The id of the namespace to write to

• --preview boolean

  Interact with a preview namespace

• --ttl number

  Time for which the entries should be visible

• --expiration number

  Time since the UNIX epoch after which the entry expires

• --metadata string

  Arbitrary JSON that is associated with a key

• --local boolean

  Interact with local storage

• --remote boolean

  Interact with remote storage

• --persist-to string

  Directory for local persistence

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

kv bulk delete

Delete multiple key-value pairs from a namespace

npm

npx wrangler kv bulk delete [FILENAME]

pnpm

pnpm wrangler kv bulk delete [FILENAME]

yarn

yarn wrangler kv bulk delete [FILENAME]

• [FILENAME] string required

  The file containing the keys to delete

• --binding string

  The binding name to the namespace to delete from

• --namespace-id string

  The id of the namespace to delete from

• --preview boolean

  Interact with a preview namespace

• --force boolean alias: --f

  Do not ask for confirmation before deleting

• --local boolean

  Interact with local storage

• --remote boolean

  Interact with remote storage

• --persist-to string

  Directory for local persistence

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

---

r2 bucket

Interact with buckets in an R2 store.

Note

The r2 bucket commands allow you to manage application data in the Cloudflare network to be accessed from Workers using the R2 API.

create

Create a new R2 bucket.

wrangler r2 bucket create <NAME>

• NAME string required
  • The name of the new R2 bucket.
• --location string optional
  • The optional location hint that determines geographic placement of the R2 bucket.
• --storage-class 'Standard|InfrequentAccess' optional
  • The default storage class for objects uploaded to the bucket.
• --jurisdiction string optional
  • The jurisdiction where the R2 bucket is created. Refer to jurisdictional restrictions.

info

Get information about an R2 bucket, including the bucket size and number of objects.

wrangler r2 bucket info <NAME>

• NAME string required
  • The name of the R2 bucket to get information about.
• --jurisdiction string optional
  • The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to jurisdictional restrictions.
• --json boolean optional
  • Return output as clean JSON.
  • Default: false

delete

Delete an R2 bucket.

wrangler r2 bucket delete <NAME>

• NAME string required
  • The name of the R2 bucket to delete.

list

List R2 bucket in the current account.

wrangler r2 bucket list

catalog enable

Enable R2 Data Catalog on an R2 bucket.

wrangler r2 bucket catalog enable <NAME> [OPTIONS]

• NAME string required
  • The name of the bucket to enable R2 Data Catalog for.

catalog disable

Disable R2 Data Catalog on an R2 bucket.

wrangler r2 bucket catalog disable <NAME> [OPTIONS]

• NAME string required
  • The name of the bucket to disable R2 Data Catalog for.

catalog get

Get the status of R2 Data Catalog for an R2 bucket, including catalog URI and warehouse name.

wrangler r2 bucket catalog get <NAME> [OPTIONS]

• NAME string required
  • The name of the R2 bucket whose data catalog status to retrieve.

catalog compaction enable

Enable compaction on a R2 Data Catalog or a specific table.

wrangler r2 bucket catalog compaction enable <BUCKET> [NAMESPACE] [TABLE] [OPTIONS]

• BUCKET string required
  • The name of the bucket to enable R2 Data Catalog compaction for.
• NAMESPACE string optional
  • The namespace containing the table (for table-level compaction). Must be provided together with TABLE.
• TABLE string optional
  • The name of the table (for table-level compaction). Must be provided together with NAMESPACE.
• --token string optional
  • The R2 API token with R2 Data Catalog edit permissions. Required for catalog-level compaction only.
• --target-size number optional
  • The target file size (in MB) compaction will attempt to generate. Default: 128. Allowed values: 64, 128, 256, 512.

Examples:

# Enable catalog-level compaction (requires token)
npx wrangler r2 bucket catalog compaction enable my-bucket --token <TOKEN>

# Enable table-level compaction
npx wrangler r2 bucket catalog compaction enable my-bucket my-namespace my-table --target-size 256

catalog compaction disable

Disable compaction on a R2 Data Catalog or a specific table.

wrangler r2 bucket catalog compaction disable <BUCKET> [NAMESPACE] [TABLE] [OPTIONS]

• BUCKET string required
  • The name of the bucket to disable R2 Data Catalog compaction for.
• NAMESPACE string optional
  • The namespace containing the table (for table-level compaction). Must be provided together with TABLE.
• TABLE string optional
  • The name of the table (for table-level compaction). Must be provided together with NAMESPACE.

Examples:

# Disable catalog-level compaction
npx wrangler r2 bucket catalog compaction disable my-bucket

# Disable table-level compaction
npx wrangler r2 bucket catalog compaction disable my-bucket my-namespace my-table

cors set

Set the CORS configuration for an R2 bucket from a JSON file.

wrangler r2 bucket cors set <NAME> [OPTIONS]

• NAME string required
  • The name of the R2 bucket to set the CORS configuration for.
• --file string required
  • Path to the JSON file containing CORS configuration (file must be in format of request body of put bucket CORS policy API).
• --jurisdiction string optional
  • The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to jurisdictional restrictions.
• --force boolean optional
  • Skip confirmation when setting CORS configuration.

cors delete

Clear the CORS configuration for an R2 bucket.

wrangler r2 bucket cors delete <NAME> [OPTIONS]

• NAME string required
  • The name of the R2 bucket to delete the CORS configuration for.
• --jurisdiction string optional
  • The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to jurisdictional restrictions.
• --force boolean optional
  • Skip confirmation when clearing the CORS configuration.

cors list

List the CORS configuration rules for an R2 bucket.

wrangler r2 bucket cors list <NAME> [OPTIONS]

• NAME string required
  • The name of the R2 bucket to list the CORS rules for.
• --jurisdiction string optional
  • The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to jurisdictional restrictions.

dev-url enable

Enable public access via the r2.dev URL for an R2 bucket.

wrangler r2 bucket dev-url enable <NAME> [OPTIONS]

• NAME string required
  • The name of the R2 bucket to enable public access via its r2.dev URL.
• --jurisdiction string optional
  • The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to jurisdictional restrictions.
• --force boolean optional
  • Skip confirmation when enabling public access via r2.dev URL.

dev-url disable

Disable public access via the r2.dev URL for an R2 bucket.

wrangler r2 bucket dev-url disable <NAME> [OPTIONS]

• NAME string required
  • The name of the R2 bucket to disable public access via its r2.dev URL.
• --jurisdiction string optional
  • The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to jurisdictional restrictions.
• --force boolean optional
  • Skip confirmation when disabling public access via r2.dev URL.

dev-url get

Get the r2.dev URL and status for an R2 bucket.

wrangler r2 bucket dev-url get <NAME> [OPTIONS]

• NAME string required
  • The name of the R2 bucket whose r2.dev URL status to retrieve.
• --jurisdiction string optional
  • The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to jurisdictional restrictions.

domain add

Connect a custom domain to an R2 bucket.

wrangler r2 bucket domain add <NAME> [OPTIONS]

• NAME string required
  • The name of the R2 bucket to connect a custom domain to.
• --domain string required
  • The custom domain to connect to the R2 bucket.
• --zone-id string required
  • The zone ID associated with the custom domain.
• --min-tls '1.0'|'1.1'|'1.2'|'1.3' optional
  • Set the minimum TLS version for the custom domain (defaults to 1.0 if not set).
• --jurisdiction string optional
  • The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to jurisdictional restrictions.
• --force boolean optional
  • Skip confirmation when adding the custom domain.

domain remove

Remove a custom domain from an R2 bucket.

wrangler r2 bucket domain remove <NAME> [OPTIONS]

• NAME string required
  • The name of the R2 bucket to remove the custom domain from.
• --domain string required
  • The custom domain to remove from the R2 bucket.
• --jurisdiction string optional
  • The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to jurisdictional restrictions.
• --force boolean optional
  • Skip confirmation when removing the custom domain.

domain update

Update settings for a custom domain connected to an R2 bucket.

wrangler r2 bucket domain update <NAME> [OPTIONS]

• NAME string required
  • The name of the R2 bucket associated with the custom domain to update.
• --domain string required
  • The custom domain whose settings will be updated.
• --min-tls '1.0'|'1.1'|'1.2'|'1.3' optional
  • Update the minimum TLS version for the custom domain.
• --jurisdiction string optional
  • The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to jurisdictional restrictions.

domain get

Get custom domain connected to an R2 bucket.

wrangler r2 bucket domain get <NAME> [OPTIONS]

• NAME string required
  • The name of the R2 bucket whose custom domain to retrieve.
• --domain string required
  • The custom domain to get information for.
• --jurisdiction string optional
  • The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to jurisdictional restrictions.

domain list

List custom domains for an R2 bucket.

wrangler r2 bucket domain list <NAME> [OPTIONS]

• NAME string required
  • The name of the R2 bucket whose connected custom domains will be listed.
• --jurisdiction string optional
  • The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to jurisdictional restrictions.

lifecycle add

Add an object lifecycle rule to an R2 bucket.

wrangler r2 bucket lifecycle add <NAME> [OPTIONS]

• NAME string required
  • The name of the R2 bucket to add a lifecycle rule to.
• --name string optional
  • A unique name for the lifecycle rule, used to identify and manage it. For example: delete-logs-180-days.
• --prefix string optional
  • Prefix condition for the lifecycle rule (leave empty for all prefixes).
• --expire-days number optional
  • Sets the lifecycle rule action to expire objects after this number of days. Note you can provide only one of --expire-days or --expire-date.
• --expire-date string optional
  • Sets the lifecycle rule action to expire objects after this date (YYYY-MM-DD). Note you can provide only one of --expire-days or --expire-date.
• --ia-transition-days number optional
  • Sets the lifecycle rule action to transition objects to Infrequent Access storage after this number of days. Note you can provide only one of --ia-transition-days or --ia-transition-date.
• --ia-transition-date string optional
  • Sets the lifecycle rule action to transition objects to Infrequent Access storage after this date (YYYY-MM-DD). Note you can provide only one of --ia-transition-days or --ia-transition-date.
• --abort-multipart-days number optional
  • Sets the lifecycle rule action to abort incomplete multipart uploads after this number of days.
• --jurisdiction string optional
  • The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to jurisdictional restrictions.
• --force boolean optional
  • Skip confirmation when adding the lifecycle rule.

lifecycle remove

Remove an object lifecycle rule from an R2 bucket.

wrangler r2 bucket lifecycle remove <NAME> [OPTIONS]

• NAME string required
  • The name of the R2 bucket to remove a lifecycle rule from.
• --name string required
  • The unique name of the lifecycle rule to remove.
• --jurisdiction string optional
  • The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to jurisdictional restrictions.

lifecycle list

List object lifecycle rules for an R2 bucket.

wrangler r2 bucket lifecycle list <NAME> [OPTIONS]

• NAME string required
  • The name of the R2 bucket to list lifecycle rules for.
• --jurisdiction string optional
  • The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to jurisdictional restrictions.

lifecycle set

Set the object lifecycle configuration for an R2 bucket from a JSON file.

wrangler r2 bucket lifecycle set <NAME> [OPTIONS]

• NAME string required
  • The name of the R2 bucket to set lifecycle configuration for.
• --file string required
  • Path to the JSON file containing lifecycle configuration (file must be in format of request body of put object lifecycle configuration API).
• --jurisdiction string optional
  • The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to jurisdictional restrictions.
• --force boolean optional
  • Skip confirmation when setting object lifecycle configuration.

lock add

Add a bucket lock rule to an R2 bucket.

wrangler r2 bucket lock add <NAME> [OPTIONS]

• NAME string required
  • The name of the R2 bucket to add a bucket lock rule to.
• --name string optional
  • A unique name for the bucket lock rule, used to identify and manage it. For example: retain-logs-180-days.
• --prefix string optional
  • Prefix condition for the bucket lock rule (leave empty for all prefixes).
• --retention-days number optional
  • Sets the number of days to retain objects for. Note you can provide only one of --retention-days, --retention-date, or --retention-indefinite.
• --retention-date string optional
  • Sets the number of days to retain objects for. Note you can provide only one of --retention-days, --retention-date, or --retention-indefinite.
• --retention-indefinite string optional
  • Sets the retention period to indefinite — meaning the lock will remain in place until explicitly removed. Note you can provide only one of --retention-days, --retention-date, or --retention-indefinite.
• --jurisdiction string optional
  • The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to jurisdictional restrictions.
• --force boolean optional
  • Skip confirmation when adding the bucket lock rule.

lock remove

Remove a bucket lock rule from an R2 bucket.

wrangler r2 bucket lock remove <NAME> [OPTIONS]

• NAME string required
  • The name of the R2 bucket to remove a bucket lock rule from.
• --name string required
  • The unique name of the bucket lock rule to remove.
• --jurisdiction string optional
  • The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to jurisdictional restrictions.

lock list

List bucket lock rules for an R2 bucket.

wrangler r2 bucket lock list <NAME> [OPTIONS]

• NAME string required
  • The name of the R2 bucket to list bucket locks rules for.
• --jurisdiction string optional
  • The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to jurisdictional restrictions.

lock set

Set the bucket lock configuration for an R2 bucket from a JSON file.

wrangler r2 bucket lock set <NAME> [OPTIONS]

• NAME string required
  • The name of the R2 bucket to set bucket lock configuration for.
• --file string required
  • Path to the JSON file containing bucket lock configuration (file must be in format of request body of put bucket lock configuration API).
• --jurisdiction string optional
  • The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to jurisdictional restrictions.
• --force boolean optional
  • Skip confirmation when setting bucket lock configuration.

notification create

Create an event notification rule for an R2 bucket.

wrangler r2 bucket notification create <NAME> [OPTIONS]

• NAME string required
  • The name of the R2 bucket to create an event notification rule for.
• --event-type 'object-create'|'object-delete'[] required
  • The type of event(s) that will trigger event notifications.
• --queue string required
  • The name of the queue that will receive event notification messages.
• --prefix string optional
  • The prefix that an object must match to emit event notifications (note: regular expressions are not supported).
• --suffix string optional
  • The suffix that an object must match to emit event notifications (note: regular expressions are not supported).
• --description string optional
  • A description that can be used to identify the event notification rule after creation.

notification delete

Remove an event notification rule from a bucket's event notification configuration.

wrangler r2 bucket notification delete <NAME> [OPTIONS]

• NAME string required
  • The name of the R2 bucket to delete an event notification rule for.
• --queue string required
  • The name of the queue that corresponds to the event notification rule. If no rule is provided, all event notification rules associated with the queue will be deleted.
• --rule string optional
  • The ID of the event notification rule to delete.

notification list

List the event notification rules for a bucket.

wrangler r2 bucket notification list <NAME>

• NAME string required
  • The name of the R2 bucket to get event notification rules for.

sippy enable

Enable Sippy incremental migration for a bucket.

wrangler r2 bucket sippy enable <NAME> [OPTIONS]

• NAME string required
  • The name of the R2 bucket to enable Sippy.
• --provider 'AWS'|'GCS' required
  • The provider of your source object storage bucket.
• --bucket string required
  • The name of your source object storage bucket.
• --r2-key-id string required
  • Your R2 Access Key ID. Requires read and write access.
• --r2-secret-access-key string required
  • Your R2 Secret Access Key. Requires read and write access.
• --jurisdiction string optional
  • The jurisdiction where the bucket exists, if a jurisdiction has been specified. Refer to jurisdictional restrictions.
• AWS S3 provider-specific options:
• --key-id string optional
  • Your AWS Access Key ID. Requires read and list access.
• --secret-access-key string optional
  • Your AWS Secret Access Key. Requires read and list access.
• --region string optional
  • The AWS region where your S3 bucket is located. For example: us-west-2.
• Google Cloud Storage provider-specific options:
• --service-account-key-file string optional
  • The path to your Google Cloud service account key JSON file. This will read the service account key file and populate client_email and private_key options. Requires read and list access.
• --client-email string optional
  • The client email for your Google Cloud service account key. Requires read and list access.
• --private-key string optional
  • The private key for your Google Cloud service account key. Requires read and list access.
• Note that you must provide either service-account-key-file or client_email and private_key for this command to run successfully.

sippy disable

Disable Sippy incremental migration for a bucket.

wrangler r2 bucket sippy disable <NAME>

• NAME string required
  • The name of the R2 bucket to disable Sippy.

sippy get

Get the status of Sippy incremental migration for a bucket.

wrangler r2 bucket sippy get <NAME>

• NAME string required
  • The name of the R2 bucket to get the status of Sippy.

r2 object

Interact with R2 objects.

Note

The r2 object commands allow you to manage application data in the Cloudflare network to be accessed from Workers using the R2 API.

get

Fetch an object from an R2 bucket.

wrangler r2 object get <OBJECT_PATH> [OPTIONS]

• OBJECT_PATH string required
  • The source object path in the form of {bucket}/{key}.
• --local boolean (default: true) optional
  • Interact with locally persisted data.
• --remote boolean (default: false) optional
  • Interact with remote storage.
• --persist-to string optional
  • Specify directory for locally persisted data.

put

Create an object in an R2 bucket.

wrangler r2 object put <OBJECT_PATH> [OPTIONS]

• OBJECT_PATH string required
  • The destination object path in the form of {bucket}/{key}.
• --file string optional
  • The path of the file to upload. Note you must provide either --file or --pipe.
• --pipe boolean optional
  • Enables the file to be piped in, rather than specified with the --file option. Note you must provide either --file or --pipe.
• --content-type string optional
  • A standard MIME type describing the format of the object data.
• --content-disposition string optional
  • Specifies presentational information for the object.
• --content-encoding string optional
  • Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
• --content-language string optional
  • The language the content is in.
• --cache-control string optional
  • Specifies caching behavior along the request/reply chain.
• --expires string optional
  • The date and time at which the object is no longer cacheable.
• --local boolean (default: true) optional
  • Interact with locally persisted data.
• --remote boolean (default: false) optional
  • Interact with remote storage.
• --persist-to string optional
  • Specify directory for locally persisted data.

delete

Delete an object in an R2 bucket.

wrangler r2 object delete <OBJECT_PATH> [OPTIONS]

• OBJECT_PATH string required
  • The destination object path in the form of {bucket}/{key}.
• --local boolean (default: true) optional
  • Interact with locally persisted data.
• --remote boolean (default: false) optional
  • Interact with remote storage.
• --persist-to string optional
  • Specify directory for locally persisted data.

Note

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

---

r2 SQL

Note

R2 SQL is currently in open beta. Report R2 SQL bugs in GitHub ↗. R2 SQL expects there to be a WRANGLER_R2_SQL_AUTH_TOKEN environment variable to be set.

query

Query a table in R2 Data Catalog using R2 SQL

wrangler r2 sql query <warehouse> <query>

• warehouse string required
  • Your R2 Data Catalog warehouse name.
• query string required
  • The SQL query to execute. Refer to the SQL reference.

---

secret

Manage the secret variables for a Worker.

This action creates a new version of the Worker and deploys it immediately. To only create a new version of the Worker, use the wrangler versions secret commands.

put

Create or replace a secret for a Worker.

wrangler secret put <KEY> [OPTIONS]

• KEY string required
  • The variable name for this secret to be accessed in the Worker.
• --name string optional
  • Perform on a specific Worker rather than inheriting from a Wrangler configuration file.
• --env string optional
  • Perform on a specific environment.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

When running this command, you will be prompted to input the secret's value:

npx wrangler secret put FOO

? Enter a secret value: › ***
🌀 Creating the secret for script worker-app
✨ Success! Uploaded secret FOO

The put command can also receive piped input. For example:

echo "-----BEGIN PRIVATE KEY-----\nM...==\n-----END PRIVATE KEY-----\n" | wrangler secret put PRIVATE_KEY

delete

Delete a secret for a Worker.

wrangler secret delete <KEY> [OPTIONS]

• KEY string required
  • The variable name for this secret to be accessed in the Worker.
• --name string optional
  • Perform on a specific Worker rather than inheriting from the Wrangler configuration file.
• --env string optional
  • Perform on a specific environment.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

list

List the names of all the secrets for a Worker.

wrangler secret list [OPTIONS]

• --name string optional
  • Perform on a specific Worker rather than inheriting from the Wrangler configuration file.
• --env string optional
  • Perform on a specific environment

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

The following is an example of listing the secrets for the current Worker.

npx wrangler secret list

[
  {
    "name": "FOO",
    "type": "secret_text"
  }
]

---

secret bulk

Upload multiple secrets for a Worker at once.

wrangler secret bulk [<FILENAME>] [OPTIONS]

• FILENAME string optional
  • A file containing either JSON ↗ or the .env ↗ format
  • The JSON file containing key-value pairs to upload as secrets, in the form {"SECRET_NAME": "secret value", ...}.
  • The .env file containing key-value pairs to upload as secrets, in the form SECRET_NAME=secret value.
  • If omitted, Wrangler expects to receive input from stdin rather than a file.
• --name string optional
  • Perform on a specific Worker rather than inheriting from the Wrangler configuration file.
• --env string optional
  • Perform on a specific environment.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

The following is an example of uploading secrets from a JSON file redirected to stdin. When complete, the output summary will show the number of secrets uploaded and the number of secrets that failed to upload.

{
  "secret-name-1": "secret-value-1",
  "secret-name-2": "secret-value-2"
}

npx wrangler secret bulk < secrets.json

🌀 Creating the secrets for the Worker "script-name"
✨ Successfully created secret for key: secret-name-1
...
🚨 Error uploading secret for key: secret-name-1
✨ Successfully created secret for key: secret-name-2

Finished processing secrets JSON file:
✨ 1 secrets successfully uploaded
🚨 1 secrets failed to upload

secrets-store secret

With the release of Secrets Store in open beta, you can use the following commands to manage your account secrets.

--remote option

In order to interact with Secrets Store in production, you should append --remote to your command. Without it, your command will default to local development mode.

create

Create a secret within a store.

wrangler secrets-store secret create <STORE_ID> [OPTIONS]

• STORE_ID string required
  • The secret store public ID. You can find it and copy from the Secrets Store tab ↗ on the dashboard.
• --name string required
  • A descriptive name for the account-level secret. Cannot contain spaces.
• --value string test only
  • Value of the secret.

    Only use for testing

    This will leave the secret value in plain-text in terminal history. For real secret values, use the automatic prompt instead. Find an example below.

• --scopes string required
  • Which services will have access to the account-level secret. Currently, only workers is available.
• --comment string optional
  • Additional information about the account-level secret.
• --remote boolean (default: false) optional
  • Execute the command against the remote Secrets Store. To interact with account-level secrets in production, make sure to append --remote to your commands.

The following is an example of using the create command to create an account-level secret.

npx wrangler secrets-store secret create 8f7a1cdced6342c18d223ece462fd88d --name ServiceA_key-1 --scopes workers --remote

✓ Enter a secret value: › ***

🔐 Creating secret... (Name: ServiceA_key-1, Value: REDACTED, Scopes: workers, Comment: undefined)
✓ Select an account: › My account
✅ Created secret! (ID: 13bc7498c6374a4e9d13be091c3c65f1)

update

Update a secret within a store.

wrangler secrets-store secret update <STORE_ID> [OPTIONS]

• STORE_ID string required
  • The ID of the secrets store that contains the secret you are updating.
• --secret-id string required
  • The ID of the secret to update.
• --value string test only
  • Updated value of the secret.

    Only use for testing

    This will leave the secret value in plain-text in terminal history. For real secret values, use the automatic prompt instead.

• --scopes string required
  • Which services will have access to the account-level secret. Currently, only workers is available.
• --comment string optional
  • Updated comment for the account-level secret.
• --remote boolean (default: false) optional
  • Execute the command against the remote Secrets Store. To interact with account-level secrets in production, make sure to append --remote to your commands.

duplicate

Duplicate a secret within a store. Use this command to create a new secret that holds the same secret value as an existing secret.

wrangler secrets-store secret duplicate <STORE_ID> [OPTIONS]

• STORE_ID string required
  • The ID of the secrets store that contains the secret you are duplicating.
• --secret-id string required
  • The ID of the secret you are duplicating.
• --name string required
  • A name for the new secret. Cannot contain spaces.
• --scopes string required
  • Which services will have access to the new account-level secret. Currently, only workers is available.
• --comment string optional
  • Additional information about the new account-level secret.
• --remote boolean (default: false) optional
  • Execute the command against the remote Secrets Store. To interact with account-level secrets in production, make sure to append --remote to your commands.

get

Get information on a secret within a store.

wrangler secrets-store secret get <STORE_ID> [OPTIONS]

• STORE_ID string required
  • The ID of the secrets store that contains the secret you want to get.
• --secret-id string required
  • The ID of the secret you want to get.
• --remote boolean (default: false) optional
  • Execute the command against the remote Secrets Store. To interact with account-level secrets in production, make sure to append --remote to your commands.

The following is an example with the expected output:

npx wrangler secrets-store secret get 8f7a1cdced6342c18d223ece462fd88d --secret-id 13bc7498c6374a4e9d13be091c3c65f1 --remote

🔐 Getting secret... (ID: 13bc7498c6374a4e9d13be091c3c65f1)
✓ Select an account: › My account
| Name                        | ID                                  | StoreID                             | Comment | Scopes  | Status  | Created                | Modified               |
|-----------------------------|-------------------------------------|-------------------------------------|---------|---------|---------|------------------------|------------------------|
| ServiceA_key-1          | 13bc7498c6374a4e9d13be091c3c65f1    | 8f7a1cdced6342c18d223ece462fd88d    |         | workers | active  | 4/9/2025, 10:06:01 PM  | 4/15/2025, 09:13:05 AM |

delete

Delete a secret within a store.

Warning

Before deleting a secret, make sure it is not deployed in any Workers application.

wrangler secrets-store secret delete <STORE_ID> [OPTIONS]

• STORE_ID string required
  • The ID of the secrets store that contains the secret you are deleting.
• --secret-id string required
  • The ID of the secret you are deleting.
• --remote boolean (default: false) optional
  • Execute the command against the remote Secrets Store. To interact with account-level secrets in production, make sure to append --remote to your commands.

list

List secrets within a store.

wrangler secrets-store secret list <STORE_ID>

• STORE_ID string required
  • The secret store public ID. You can find it and copy from the Secrets Store tab ↗ on the dashboard.

secrets-store store

Use the following commands to manage your store.

Store limitation

Secrets Store is in open beta. Currently, you can only have one store per Cloudflare account.

create

Create a store within Secrets Store.

wrangler secrets-store store create <name>

• name string required
  • A descriptive name for the account-level secret. Cannot contain spaces.
• --remote boolean (default: false) required
  • Execute the command against the remote Secrets Store.

The following is an example of using the create command to create a store.

npx wrangler secrets-store store create default --remote

🔐 Creating store... (Name: default)
✅ Created store! (Name: default, ID: 2e2a82d317134506b58defbe16982d54)

delete

Delete a store within Secrets Store.

wrangler secrets-store store delete <STORE_ID>

• STORE_ID string required
  • The secret store public ID. You can find it and copy from the Secrets Store tab ↗ on the dashboard.
• --remote boolean (default: false) required
  • Execute the command against the remote Secrets Store.

The following is an example of using the delete command to delete a store.

npx wrangler secrets-store store delete d2dafaeac9434de2b6d08b292ce08211 --remote

🔐 Deleting store... (Name: d2dafaeac9434de2b6d08b292ce08211)
✅ Deleted store! (ID: d2dafaeac9434de2b6d08b292ce08211)

list

List the stores within an account.

wrangler secrets-store store list

• --remote boolean (default: false) required
  • Execute the command against the remote Secrets Store.

The following is an example of using the list command to list stores.

npx wrangler secrets-store store list --remote

🔐 Listing stores...
┌─────────┬──────────────────────────────────┬──────────────────────────────────┬──────────────────────┬──────────────────────┐
│ Name    │ ID                               │ AccountID                        │ Created              │ Modified             │
├─────────┼──────────────────────────────────┼──────────────────────────────────┼──────────────────────┼──────────────────────┤
│ default │ 8876bad33f164462bf0743fe8adf98f4 │ REDACTED │ 4/9/2025, 1:11:48 PM  │ 4/9/2025, 1:11:48 PM │
└─────────┴──────────────────────────────────┴──────────────────────────────────┴──────────────────────┴──────────────────────┘

workflows

Note

The wrangler workflows command requires Wrangler version 3.83.0 or greater. Use npx wrangler@latest to always use the latest Wrangler version when invoking commands.

Manage and configure Workflows.

list

Lists the registered Workflows for this account.

wrangler workflows list

• --page number optional
  • Show a specific page from the listing. You can configure page size using "per-page".
• --per-page number optional
  • Configure the maximum number of Workflows to show per page.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

instances

Manage and interact with specific instances of a Workflow.

instances list

List Workflow instances.

wrangler workflows instances list <WORKFLOW_NAME> [OPTIONS]

• WORKFLOW_NAME string required
  • The name of a registered Workflow.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

instances describe

Describe a specific instance of a Workflow, including its current status, any persisted state, and per-step outputs.

wrangler workflows instances describe <WORKFLOW_NAME> [ID] [OPTIONS]

• WORKFLOW_NAME string required
  • The name of a registered Workflow.
• ID string (default: latest) optional
  • The ID of a Workflow instance. You can optionally provide latest to refer to the most recently created instance of a Workflow. Defaults to latest if no ID is provided.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

# Passing `latest` instead of an explicit ID will describe the most recently queued instance
wrangler workflows instances describe my-workflow latest

Workflow Name:         my-workflow
Instance Id:           51c73fc8-7fd5-47d9-bd82-9e301506ee72
Version Id:            cedc33a0-11fa-4c26-8a8e-7d28d381a291
Status:                ✅ Completed
Trigger:               🌎 API
Queued:                10/16/2024, 2:00:39 PM
Success:               ✅ Yes
Start:                 10/16/2024, 2:00:39 PM
End:                   10/16/2024, 2:01:40 PM
Duration:              1 minute
# Remaining output truncated

instances terminate

Terminate (permanently stop) a Workflow instance.

wrangler workflows instances terminate <WORKFLOW_NAME> <ID> [OPTIONS]

• WORKFLOW_NAME string required
  • The name of a registered Workflow.
• ID string required
  • The ID of a Workflow instance.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

instances pause

Pause (until resumed) a Workflow instance.

wrangler workflows instances pause <WORKFLOW_NAME> <ID> [OPTIONS]

• WORKFLOW_NAME string required
  • The name of a registered Workflow.
• ID string required
  • The ID of a Workflow instance.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

instances resume

Resume a paused Workflow instance.

wrangler workflows instances resume <WORKFLOW_NAME> <ID> [OPTIONS]

• WORKFLOW_NAME string required
  • The name of a registered Workflow.
• ID string required
  • The ID of a Workflow instance.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

describe

wrangler workflows describe <WORKFLOW_NAME> [OPTIONS]

• WORKFLOW_NAME string required
  • The name of a registered Workflow.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

delete

Delete a Workflow and all its instances.

wrangler workflows delete <WORKFLOW_NAME> [OPTIONS]

• WORKFLOW_NAME string required
  • The name of a registered Workflow.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

wrangler workflows instances delete my-workflow

trigger

Trigger (create) a Workflow instance.

wrangler workflows trigger <WORKFLOW_NAME> <PARAMS> [OPTIONS]

• WORKFLOW_NAME string required
  • The name of a registered Workflow.
• PARAMS string optional
  • The parameters to pass to the Workflow as an event. Must be a JSON-encoded string.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

# Pass optional params to the Workflow.
wrangler workflows trigger my-workflow '{"hello":"world"}'

tail

🦚 Start a log tailing session for a Worker

npm

npx wrangler tail [WORKER]

pnpm

pnpm wrangler tail [WORKER]

yarn

yarn wrangler tail [WORKER]

• [WORKER] string

  Name or route of the worker to tail

• --format "json" | "pretty"

  The format of log entries

• --status "ok" | "error" | "canceled"

  Filter by invocation status

• --header string

  Filter by HTTP header

• --method string

  Filter by HTTP method

• --sampling-rate number

  Adds a percentage of requests to log sampling rate

• --search string

  Filter by a text match in console.log messages

• --ip string

  Filter by the IP address the request originates from. Use "self" to filter for your own IP

• --version-id string

  Filter by Worker version

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

After starting wrangler tail, you will receive a live feed of console and exception logs for each request your Worker receives.

If your Worker has a high volume of traffic, the tail might enter sampling mode. This will cause some of your messages to be dropped and a warning to appear in your tail logs. To prevent messages from being dropped, add the options listed above to filter the volume of tail messages.

Note

It may take up to 1 minute (60 seconds) for a tail to exit sampling mode after adding an option to filter tail messages.

If sampling persists after using options to filter messages, consider using instant logs ↗.

---

pages

Configure Cloudflare Pages.

dev

Develop your full-stack Pages application locally.

wrangler pages dev [<DIRECTORY>] [OPTIONS]

• DIRECTORY string optional
  • The directory of static assets to serve.
• --local boolean optional (default: true)
  • Run on your local machine.
• --ip string optional
  • IP address to listen on, defaults to localhost.
• --port number optional (default: 8788)
  • The port to listen on (serve from).
• --config, -c string[] optional
  • Path(s) to Wrangler configuration file. If not provided, Wrangler will use the nearest config file based on your current working directory.
  • You can provide additional configuration files in order to run Workers alongside your Pages project, like this: wrangler pages dev -c ./wrangler.toml -c ../other-worker/wrangler.toml. The first argument must point to your Pages configuration file, and the subsequent configurations will be accessible via a Service binding from your Pages project.
• --binding string[] optional
  • Bind an environment variable or secret (for example, --binding <VARIABLE_NAME>=<VALUE>).
• --kv string[] optional
  • Binding name of KV namespace to bind (for example, --kv <BINDING_NAME>).
• --r2 string[] optional
  • Binding name of R2 bucket to bind (for example, --r2 <BINDING_NAME>).
• --d1 string[] optional
  • Binding name of D1 database to bind (for example, --d1 <BINDING_NAME>).
• --do string[] optional
  • Binding name of Durable Object to bind (for example, --do <BINDING_NAME>=<CLASS>).
• --live-reload boolean optional (default: false)
  • Auto reload HTML pages when change is detected.
• --compatibility-flag string[] optional
  • Runtime compatibility flags to apply.
• --compatibility-date string optional
  • Runtime compatibility date to apply.
• --show-interactive-dev-session boolean optional (default: true if the terminal supports interactivity)
  • Show the interactive dev session.
• --https-key-path string optional
  • Path to a custom certificate key.
• --https-cert-path string optional
  • Path to a custom certificate.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

download config

Download your Pages project config as a Wrangler configuration file.

wrangler pages download config <PROJECT_NAME>

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

project list

List your Pages projects.

wrangler pages project list

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

project create

Create a new Cloudflare Pages project.

wrangler pages project create <PROJECT_NAME> [OPTIONS]

• PROJECT_NAME string required
  • The name of your Pages project.
• --production-branch string optional
  • The name of the production branch of your project.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

project delete

Delete a Cloudflare Pages project.

wrangler pages project delete <PROJECT_NAME> [OPTIONS]

• PROJECT_NAME string required
  • The name of the Pages project to delete.
• --yes boolean optional
  • Answer "yes" to confirmation prompt.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

deployment list

List deployments in your Cloudflare Pages project.

wrangler pages deployment list [--project-name <PROJECT_NAME>]

• --project-name string optional
  • The name of the project you would like to list deployments for.
• --environment 'production'|'preview' optional
  • Environment type to list deployments for.
• --json boolean optional
  • Whether to output the list in JSON format.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

deployment tail

Start a session to livestream logs from your deployed Pages Functions.

wrangler pages deployment tail [<DEPLOYMENT>] [OPTIONS]

• DEPLOYMENT string optional
  • ID or URL of the deployment to tail. Specify by environment if deployment ID is unknown.
• --project-name string optional
  • The name of the project you would like to tail.
• --environment 'production'|'preview' optional
  • When not providing a specific deployment ID, specifying environment will grab the latest production or preview deployment.
• --format 'json'|'pretty' optional
  • The format of the log entries.
• --status 'ok'|'error'|'canceled' optional
  • Filter by invocation status.
• --header string optional
  • Filter by HTTP header.
• --method string optional
  • Filter by HTTP method.
• --sampling-rate number optional
  • Add a percentage of requests to log sampling rate.
• --search string optional
  • Filter by a text match in console.log messages.
• --ip (string|'self')\[] optional
  • Filter by the IP address the request originates from. Use "self" to show only messages from your own IP.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

Note

Filtering with --ip self will allow tailing your deployed Functions beyond the normal request per second limits.

After starting wrangler pages deployment tail, you will receive a live stream of console and exception logs for each request your Functions receive.

deploy

Deploy a directory of static assets as a Pages deployment.

wrangler pages deploy <BUILD_OUTPUT_DIRECTORY> [OPTIONS]

• BUILD_OUTPUT_DIRECTORY string optional
  • The directory of static files to upload. As of Wrangler 3.45.0, this is only required when your Pages project does not have a Wrangler file. Refer to the Pages Functions configuration guide for more information.
• --project-name string optional
  • The name of the project you want to deploy to.
• --branch string optional
  • The name of the branch you want to deploy to.
• --commit-hash string optional
  • The SHA to attach to this deployment.
• --commit-message string optional
  • The commit message to attach to this deployment.
• --commit-dirty boolean optional
  • Whether or not the workspace should be considered dirty for this deployment.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

Note

Your site is deployed to <PROJECT_NAME>.pages.dev. If you do not provide the --project-name argument, you will be prompted to enter a project name in your terminal after you run the command.

secret put

Create or update a secret for a Pages project.

wrangler pages secret put <KEY> [OPTIONS]

• KEY string required
  • The variable name for this secret to be accessed in the Pages project.
• --project-name string optional
  • The name of your Pages project.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

secret delete

Delete a secret from a Pages project.

wrangler pages secret delete <KEY> [OPTIONS]

• KEY string required
  • The variable name for this secret to be accessed in the Pages project.
• --project-name string optional
  • The name of your Pages project.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

secret list

List the names of all the secrets for a Pages project.

wrangler pages secret list [OPTIONS]

• --project-name string optional
  • The name of your Pages project.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

secret bulk

Upload multiple secrets for a Pages project at once.

wrangler pages secret bulk [<FILENAME>] [OPTIONS]

• FILENAME string optional
  • A file containing either JSON ↗ or the .env ↗ format
  • The JSON file containing key-value pairs to upload as secrets, in the form {"SECRET_NAME": "secret value", ...}.
  • The .env file containing key-value pairs to upload as secrets, in the form SECRET_NAME=secret value.
  • If omitted, Wrangler expects to receive input from stdin rather than a file.
• --project-name string optional
  • The name of your Pages project.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

functions build

Compile a folder of Pages Functions into a single Worker.

wrangler pages functions build [<DIRECTORY>] [OPTIONS]

• DIRECTORY string optional (default: `functions`)
  • The directory of Pages Functions.
• --outdir string optional
  • Output directory for the bundled Worker.
• --fallback-service string optional (default: `ASSETS`)
  • The service to fallback to at the end of the next chain. Setting to '' will fallback to the global fetch.
• --compatibility-date string optional
  • Date to use for compatibility checks.
• --compatibility-flags string[] optional
  • Flags to use for compatibility checks.
• --metafile string optional
  • Specify a file to write the build metadata from esbuild to. If flag is used without a path string, this defaults to bundle-meta.json inside the directory specified by --outdir. This can be useful for understanding the bundle size.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

---

pipelines

Manage your Pipelines.

pipelines setup

Interactive setup for a complete pipeline

npm

npx wrangler pipelines setup

pnpm

pnpm wrangler pipelines setup

yarn

yarn wrangler pipelines setup

• --name string

  Pipeline name

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

pipelines create

Create a new pipeline

npm

npx wrangler pipelines create [PIPELINE]

pnpm

pnpm wrangler pipelines create [PIPELINE]

yarn

yarn wrangler pipelines create [PIPELINE]

• [PIPELINE] string required

  The name of the pipeline to create

• --sql string

  Inline SQL query for the pipeline

• --sql-file string

  Path to file containing SQL query for the pipeline

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

pipelines list

List all pipelines

npm

npx wrangler pipelines list

pnpm

pnpm wrangler pipelines list

yarn

yarn wrangler pipelines list

• --page number default: 1

  Page number for pagination

• --per-page number default: 20

  Number of pipelines per page

• --json boolean default: false

  Output in JSON format

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

pipelines get

Get details about a specific pipeline

npm

npx wrangler pipelines get [PIPELINE]

pnpm

pnpm wrangler pipelines get [PIPELINE]

yarn

yarn wrangler pipelines get [PIPELINE]

• [PIPELINE] string required

  The ID of the pipeline to retrieve

• --json boolean default: false

  Output in JSON format

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

pipelines update

Update a pipeline configuration (legacy pipelines only)

npm

npx wrangler pipelines update [PIPELINE]

pnpm

pnpm wrangler pipelines update [PIPELINE]

yarn

yarn wrangler pipelines update [PIPELINE]

• [PIPELINE] string required

  The name of the legacy pipeline to update

• --source array

  Space separated list of allowed sources. Options are 'http' or 'worker'

• --require-http-auth boolean

  Require Cloudflare API Token for HTTPS endpoint authentication

• --cors-origins array

  CORS origin allowlist for HTTP endpoint (use * for any origin). Defaults to an empty array

• --batch-max-mb number

  Maximum batch size in megabytes before flushing. Defaults to 100 MB if unset. Minimum: 1, Maximum: 100

• --batch-max-rows number

  Maximum number of rows per batch before flushing. Defaults to 10,000,000 if unset. Minimum: 100, Maximum: 10,000,000

• --batch-max-seconds number

  Maximum age of batch in seconds before flushing. Defaults to 300 if unset. Minimum: 1, Maximum: 300

• --r2-bucket string

  Destination R2 bucket name

• --r2-access-key-id string

  R2 service Access Key ID for authentication. Leave empty for OAuth confirmation.

• --r2-secret-access-key string

  R2 service Secret Access Key for authentication. Leave empty for OAuth confirmation.

• --r2-prefix string

  Prefix for storing files in the destination bucket. Default is no prefix

• --compression string

  Compression format for output files

• --shard-count number

  Number of shards for the pipeline. More shards handle higher request volume; fewer shards produce larger output files. Defaults to 2 if unset. Minimum: 1, Maximum: 15

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

pipelines delete

Delete a pipeline

npm

npx wrangler pipelines delete [PIPELINE]

pnpm

pnpm wrangler pipelines delete [PIPELINE]

yarn

yarn wrangler pipelines delete [PIPELINE]

• [PIPELINE] string required

  The ID or name of the pipeline to delete

• --force boolean alias: --y default: false

  Skip confirmation

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

pipelines streams create

Create a new stream

npm

npx wrangler pipelines streams create [STREAM]

pnpm

pnpm wrangler pipelines streams create [STREAM]

yarn

yarn wrangler pipelines streams create [STREAM]

• [STREAM] string required

  The name of the stream to create

• --schema-file string

  Path to JSON file containing stream schema

• --http-enabled boolean default: true

  Enable HTTP endpoint

• --http-auth boolean default: true

  Require authentication for HTTP endpoint

• --cors-origin string

  CORS origin

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

pipelines streams list

List all streams

npm

npx wrangler pipelines streams list

pnpm

pnpm wrangler pipelines streams list

yarn

yarn wrangler pipelines streams list

• --page number default: 1

  Page number for pagination

• --per-page number default: 20

  Number of streams per page

• --pipeline-id string

  Filter streams by pipeline ID

• --json boolean default: false

  Output in JSON format

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

pipelines streams get

Get details about a specific stream

npm

npx wrangler pipelines streams get [STREAM]

pnpm

pnpm wrangler pipelines streams get [STREAM]

yarn

yarn wrangler pipelines streams get [STREAM]

• [STREAM] string required

  The ID of the stream to retrieve

• --json boolean default: false

  Output in JSON format

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

pipelines streams delete

Delete a stream

npm

npx wrangler pipelines streams delete [STREAM]

pnpm

pnpm wrangler pipelines streams delete [STREAM]

yarn

yarn wrangler pipelines streams delete [STREAM]

• [STREAM] string required

  The ID of the stream to delete

• --force boolean alias: --y default: false

  Skip confirmation

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

pipelines sinks create

Create a new sink

npm

npx wrangler pipelines sinks create [SINK]

pnpm

pnpm wrangler pipelines sinks create [SINK]

yarn

yarn wrangler pipelines sinks create [SINK]

• [SINK] string required

  The name of the sink to create

• --type string required

  The type of sink to create

• --bucket string required

  R2 bucket name

• --format string default: parquet

  Output format

• --compression string default: zstd

  Compression method (parquet only)

• --target-row-group-size string

  Target row group size for parquet format

• --path string

  The base prefix in your bucket where data will be written

• --partitioning string

  Time partition pattern (r2 sinks only)

• --roll-size number

  Roll file size in MB

• --roll-interval number default: 300

  Roll file interval in seconds

• --access-key-id string

  R2 access key ID (leave empty for R2 credentials to be automatically created)

• --secret-access-key string

  R2 secret access key (leave empty for R2 credentials to be automatically created)

• --namespace string

  Data catalog namespace (required for r2-data-catalog)

• --table string

  Table name within namespace (required for r2-data-catalog)

• --catalog-token string

  Authentication token for data catalog (required for r2-data-catalog)

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

pipelines sinks list

List all sinks

npm

npx wrangler pipelines sinks list

pnpm

pnpm wrangler pipelines sinks list

yarn

yarn wrangler pipelines sinks list

• --page number default: 1

  Page number for pagination

• --per-page number default: 20

  Number of sinks per page

• --pipeline-id string

  Filter sinks by pipeline ID

• --json boolean default: false

  Output in JSON format

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

pipelines sinks get

Get details about a specific sink

npm

npx wrangler pipelines sinks get [SINK]

pnpm

pnpm wrangler pipelines sinks get [SINK]

yarn

yarn wrangler pipelines sinks get [SINK]

• [SINK] string required

  The ID of the sink to retrieve

• --json boolean default: false

  Output in JSON format

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

pipelines sinks delete

Delete a sink

npm

npx wrangler pipelines sinks delete [SINK]

pnpm

pnpm wrangler pipelines sinks delete [SINK]

yarn

yarn wrangler pipelines sinks delete [SINK]

• [SINK] string required

  The ID of the sink to delete

• --force boolean alias: --y default: false

  Skip confirmation

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

---

queues

Manage your Workers Queues configurations.

queues list

List queues

npm

npx wrangler queues list

pnpm

pnpm wrangler queues list

yarn

yarn wrangler queues list

• --page number

  Page number for pagination

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

queues create

Create a queue

npm

npx wrangler queues create [NAME]

pnpm

pnpm wrangler queues create [NAME]

yarn

yarn wrangler queues create [NAME]

• [NAME] string required

  The name of the queue

• --delivery-delay-secs number default: 0

  How long a published message should be delayed for, in seconds. Must be between 0 and 42300

• --message-retention-period-secs number default: 345600

  How long to retain a message in the queue, in seconds. Must be between 60 and 1209600

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

queues update

Update a queue

npm

npx wrangler queues update [NAME]

pnpm

pnpm wrangler queues update [NAME]

yarn

yarn wrangler queues update [NAME]

• [NAME] string required

  The name of the queue

• --delivery-delay-secs number

  How long a published message should be delayed for, in seconds. Must be between 0 and 42300

• --message-retention-period-secs number

  How long to retain a message in the queue, in seconds. Must be between 60 and 1209600

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

queues delete

Delete a queue

npm

npx wrangler queues delete [NAME]

pnpm

pnpm wrangler queues delete [NAME]

yarn

yarn wrangler queues delete [NAME]

• [NAME] string required

  The name of the queue

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

queues info

Get queue information

npm

npx wrangler queues info [NAME]

pnpm

pnpm wrangler queues info [NAME]

yarn

yarn wrangler queues info [NAME]

• [NAME] string required

  The name of the queue

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

queues consumer add

Add a Queue Worker Consumer

npm

npx wrangler queues consumer add [QUEUE-NAME] [SCRIPT-NAME]

pnpm

pnpm wrangler queues consumer add [QUEUE-NAME] [SCRIPT-NAME]

yarn

yarn wrangler queues consumer add [QUEUE-NAME] [SCRIPT-NAME]

• [QUEUE-NAME] string required

  Name of the queue to configure

• [SCRIPT-NAME] string required

  Name of the consumer script

• --batch-size number

  Maximum number of messages per batch

• --batch-timeout number

  Maximum number of seconds to wait to fill a batch with messages

• --message-retries number

  Maximum number of retries for each message

• --dead-letter-queue string

  Queue to send messages that failed to be consumed

• --max-concurrency number

  The maximum number of concurrent consumer Worker invocations. Must be a positive integer

• --retry-delay-secs number

  The number of seconds to wait before retrying a message

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

queues consumer remove

Remove a Queue Worker Consumer

npm

npx wrangler queues consumer remove [QUEUE-NAME] [SCRIPT-NAME]

pnpm

pnpm wrangler queues consumer remove [QUEUE-NAME] [SCRIPT-NAME]

yarn

yarn wrangler queues consumer remove [QUEUE-NAME] [SCRIPT-NAME]

• [QUEUE-NAME] string required

  Name of the queue to configure

• [SCRIPT-NAME] string required

  Name of the consumer script

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

queues consumer http add

Add a Queue HTTP Pull Consumer

npm

npx wrangler queues consumer http add [QUEUE-NAME]

pnpm

pnpm wrangler queues consumer http add [QUEUE-NAME]

yarn

yarn wrangler queues consumer http add [QUEUE-NAME]

• [QUEUE-NAME] string required

  Name of the queue for the consumer

• --batch-size number

  Maximum number of messages per batch

• --message-retries number

  Maximum number of retries for each message

• --dead-letter-queue string

  Queue to send messages that failed to be consumed

• --visibility-timeout-secs number

  The number of seconds a message will wait for an acknowledgement before being returned to the queue.

• --retry-delay-secs number

  The number of seconds to wait before retrying a message

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

queues consumer http remove

Remove a Queue HTTP Pull Consumer

npm

npx wrangler queues consumer http remove [QUEUE-NAME]

pnpm

pnpm wrangler queues consumer http remove [QUEUE-NAME]

yarn

yarn wrangler queues consumer http remove [QUEUE-NAME]

• [QUEUE-NAME] string required

  Name of the queue for the consumer

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

queues consumer worker add

Add a Queue Worker Consumer

npm

npx wrangler queues consumer worker add [QUEUE-NAME] [SCRIPT-NAME]

pnpm

pnpm wrangler queues consumer worker add [QUEUE-NAME] [SCRIPT-NAME]

yarn

yarn wrangler queues consumer worker add [QUEUE-NAME] [SCRIPT-NAME]

• [QUEUE-NAME] string required

  Name of the queue to configure

• [SCRIPT-NAME] string required

  Name of the consumer script

• --batch-size number

  Maximum number of messages per batch

• --batch-timeout number

  Maximum number of seconds to wait to fill a batch with messages

• --message-retries number

  Maximum number of retries for each message

• --dead-letter-queue string

  Queue to send messages that failed to be consumed

• --max-concurrency number

  The maximum number of concurrent consumer Worker invocations. Must be a positive integer

• --retry-delay-secs number

  The number of seconds to wait before retrying a message

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

queues consumer worker remove

Remove a Queue Worker Consumer

npm

npx wrangler queues consumer worker remove [QUEUE-NAME] [SCRIPT-NAME]

pnpm

pnpm wrangler queues consumer worker remove [QUEUE-NAME] [SCRIPT-NAME]

yarn

yarn wrangler queues consumer worker remove [QUEUE-NAME] [SCRIPT-NAME]

• [QUEUE-NAME] string required

  Name of the queue to configure

• [SCRIPT-NAME] string required

  Name of the consumer script

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

queues pause-delivery

Pause message delivery for a queue

npm

npx wrangler queues pause-delivery [NAME]

pnpm

pnpm wrangler queues pause-delivery [NAME]

yarn

yarn wrangler queues pause-delivery [NAME]

• [NAME] string required

  The name of the queue

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

queues resume-delivery

Resume message delivery for a queue

npm

npx wrangler queues resume-delivery [NAME]

pnpm

pnpm wrangler queues resume-delivery [NAME]

yarn

yarn wrangler queues resume-delivery [NAME]

• [NAME] string required

  The name of the queue

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

queues purge

Purge messages from a queue

npm

npx wrangler queues purge [NAME]

pnpm

pnpm wrangler queues purge [NAME]

yarn

yarn wrangler queues purge [NAME]

• [NAME] string required

  The name of the queue

• --force boolean

  Skip the confirmation dialog and forcefully purge the Queue

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

queues subscription create

Create a new event subscription for a queue

npm

npx wrangler queues subscription create [QUEUE]

pnpm

pnpm wrangler queues subscription create [QUEUE]

yarn

yarn wrangler queues subscription create [QUEUE]

• [QUEUE] string required

  The name of the queue to create the subscription for

• --source string required

  The event source type

• --events string required

  Comma-separated list of event types to subscribe to

• --name string

  Name for the subscription (auto-generated if not provided)

• --enabled boolean default: true

  Whether the subscription should be active

• --model-name string

  Workers AI model name (required for workersAi.model source)

• --worker-name string

  Worker name (required for workersBuilds.worker source)

• --workflow-name string

  Workflow name (required for workflows.workflow source)

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

queues subscription list

List event subscriptions for a queue

npm

npx wrangler queues subscription list [QUEUE]

pnpm

pnpm wrangler queues subscription list [QUEUE]

yarn

yarn wrangler queues subscription list [QUEUE]

• [QUEUE] string required

  The name of the queue to list subscriptions for

• --page number default: 1

  Page number for pagination

• --per-page number default: 20

  Number of subscriptions per page

• --json boolean default: false

  Output in JSON format

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

queues subscription get

Get details about a specific event subscription

npm

npx wrangler queues subscription get [QUEUE]

pnpm

pnpm wrangler queues subscription get [QUEUE]

yarn

yarn wrangler queues subscription get [QUEUE]

• [QUEUE] string required

  The name of the queue

• --id string required

  The ID of the subscription to retrieve

• --json boolean default: false

  Output in JSON format

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

queues subscription delete

Delete an event subscription from a queue

npm

npx wrangler queues subscription delete [QUEUE]

pnpm

pnpm wrangler queues subscription delete [QUEUE]

yarn

yarn wrangler queues subscription delete [QUEUE]

• [QUEUE] string required

  The name of the queue

• --id string required

  The ID of the subscription to delete

• --force boolean alias: --y default: false

  Skip confirmation

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

queues subscription update

Update an existing event subscription

npm

npx wrangler queues subscription update [QUEUE]

pnpm

pnpm wrangler queues subscription update [QUEUE]

yarn

yarn wrangler queues subscription update [QUEUE]

• [QUEUE] string required

  The name of the queue

• --id string required

  The ID of the subscription to update

• --name string

  New name for the subscription

• --events string

  Comma-separated list of event types to subscribe to

• --enabled boolean

  Whether the subscription should be active

• --json boolean default: false

  Output in JSON format

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

---

login

Authorize Wrangler with your Cloudflare account using OAuth. Wrangler will attempt to automatically open your web browser to login with your Cloudflare account.

If you prefer to use API tokens for authentication, such as in headless or continuous integration environments, refer to Running Wrangler in CI/CD.

wrangler login [OPTIONS]

• --scopes-list string optional
  • List all the available OAuth scopes with descriptions.
• --scopes string optional
  • Allows to choose your set of OAuth scopes. The set of scopes must be entered in a whitespace-separated list, for example, npx wrangler login --scopes account:read user:read.
• --callback-host string optional
  • Defaults to localhost. Sets the IP or hostname where Wrangler should listen for the OAuth callback.
• --callback-port string optional
  • Defaults to 8976. Sets the port where Wrangler should listen for the OAuth callback.

Note

wrangler login uses all the available scopes by default if no flags are provided.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

If Wrangler fails to open a browser, you can copy and paste the URL generated by wrangler login in your terminal into a browser and log in.

Use wrangler login on a remote machine

If you are using Wrangler from a remote machine, but run the login flow from your local browser, you will receive the following error message after logging in:This site can't be reached.

To finish the login flow, run wrangler login and go through the login flow in the browser:

npx wrangler login

 ⛅️ wrangler 2.1.6
-------------------
Attempting to login via OAuth...
Opening a link in your default browser: https://dash.cloudflare.com/oauth2/auth?xyz...

The browser login flow will redirect you to a localhost URL on your machine.

Leave the login flow active. Open a second terminal session. In that second terminal session, use curl or an equivalent request library on the remote machine to fetch this localhost URL. Copy and paste the localhost URL that was generated during the wrangler login flow and run:

curl <LOCALHOST_URL>

---

logout

Remove Wrangler's authorization for accessing your account. This command will invalidate your current OAuth token.

wrangler logout

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

If you are using CLOUDFLARE_API_TOKEN instead of OAuth, and you can logout by deleting your API token in the Cloudflare dashboard:

1. In the Cloudflare dashboard, go to the Account API tokens page.

   Go to Account API tokens

2. Select the three-dot menu on your Wrangler token.

3. Select Delete.

---

whoami

🕵️ Retrieve your user information

npm

npx wrangler whoami

pnpm

pnpm wrangler whoami

yarn

yarn wrangler whoami

• --account string

  Show membership information for the given account (id or name).

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

---

versions

Note

The minimum required wrangler version to use these commands is 3.40.0. For versions before 3.73.0, you will need to add the --x-versions flag.

versions upload

Upload a new version of your Worker that is not deployed immediately.

npm

npx wrangler versions upload [SCRIPT]

pnpm

pnpm wrangler versions upload [SCRIPT]

yarn

yarn wrangler versions upload [SCRIPT]

• [SCRIPT] string

  The path to an entry point for your Worker

• --name string

  Name of the Worker

• --tag string

  A tag for this Worker Gradual Rollouts Version

• --message string

  A descriptive message for this Worker Gradual Rollouts Version

• --preview-alias string

  Name of an alias for this Worker version

• --no-bundle boolean default: false

  Skip internal build steps and directly upload Worker

• --outdir string

  Output directory for the bundled Worker

• --outfile string

  Output file for the bundled worker

• --compatibility-date string

  Date to use for compatibility checks

• --compatibility-flags string alias: --compatibility-flag

  Flags to use for compatibility checks

• --latest boolean default: false

  Use the latest version of the Worker runtime

• --assets string

  Static assets to be served. Replaces Workers Sites.

• --var string

  A key-value pair to be injected into the script as a variable

• --define string

  A key-value pair to be substituted in the script

• --alias string

  A module pair to be substituted in the script

• --jsx-factory string

  The function that is called for each JSX element

• --jsx-fragment string

  The function that is called for each JSX fragment

• --tsconfig string

  Path to a custom tsconfig.json file

• --minify boolean

  Minify the Worker

• --upload-source-maps boolean

  Include source maps when uploading this Worker Gradual Rollouts Version.

• --dry-run boolean

  Compile a project without actually uploading the version.

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

versions deploy

Deploy a previously created version of your Worker all at once or create a gradual deployment to incrementally shift traffic to a new version by following an interactive prompt.

npm

npx wrangler versions deploy [VERSION-SPECS]

pnpm

pnpm wrangler versions deploy [VERSION-SPECS]

yarn

yarn wrangler versions deploy [VERSION-SPECS]

• --name string

  Name of the worker

• --version-id string

  Worker Version ID(s) to deploy

• --percentage number

  Percentage of traffic to split between Worker Version(s) (0-100)

• [VERSION-SPECS] string

  Shorthand notation to deploy Worker Version(s) [<version-id>@<percentage>..]

• --message string

  Description of this deployment (optional)

• --yes boolean alias: --y default: false

  Automatically accept defaults to prompts

• --dry-run boolean default: false

  Don't actually deploy

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

Note

The non-interactive version of this prompt is: wrangler versions deploy version-id-1@percentage-1% version-id-2@percentage-2 -y

For example: wrangler versions deploy 095f00a7-23a7-43b7-a227-e4c97cab5f22@10% 1a88955c-2fbd-4a72-9d9b-3ba1e59842f2@90% -y

versions list

Retrieve details for the 10 most recent versions. Details include Version ID, Created on, Author, Source, and optionally, Tag or Message.

npm

npx wrangler versions list

pnpm

pnpm wrangler versions list

yarn

yarn wrangler versions list

• --name string

  Name of the Worker

• --json boolean default: false

  Display output as clean JSON

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

versions view

View the details of a specific version of your Worker

npm

npx wrangler versions view [VERSION-ID]

pnpm

pnpm wrangler versions view [VERSION-ID]

yarn

yarn wrangler versions view [VERSION-ID]

• [VERSION-ID] string required

  The Worker Version ID to view

• --name string

  Name of the worker

• --json boolean default: false

  Display output as clean JSON

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

secret put

Create or replace a secret for a Worker. Creates a new version with modified secrets without deploying the Worker.

wrangler versions secret put <KEY> [OPTIONS]

• KEY string required
  • The variable name for this secret to be accessed in the Worker.
• --name string optional
  • Perform on a specific Worker rather than inheriting from the Wrangler configuration file.
• --env string optional
  • Perform on a specific environment.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

secret delete

Delete a secret for a Worker. Creates a new version with modified secrets without deploying the Worker.

wrangler versions secret delete <KEY> [OPTIONS]

• KEY string required
  • The variable name for this secret to be accessed in the Worker.
• --name string optional
  • Perform on a specific Worker rather than inheriting from the Wrangler configuration file.
• --env string optional
  • Perform on a specific environment.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

secret bulk

Upload multiple secrets for a Worker at once. Creates a new version with modified secrets without deploying the Worker.

wrangler versions secret bulk <FILENAME> [OPTIONS]

• FILENAME string optional
  • A file containing either JSON ↗ or the .env ↗ format
  • The JSON file containing key-value pairs to upload as secrets, in the form {"SECRET_NAME": "secret value", ...}.
  • The .env file containing key-value pairs to upload as secrets, in the form SECRET_NAME=secret value.
  • If omitted, Wrangler expects to receive input from stdin rather than a file.
• --name string optional
  • Perform on a specific Worker rather than inheriting from the Wrangler configuration file.
• --env string optional
  • Perform on a specific environment.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

---

triggers

Note

The minimum required wrangler version to use these commands is 3.40.0. For versions before 3.73.0, you will need to add the --x-versions flag.

deploy

Apply changes to triggers (Routes or domains and Cron Triggers) when using wrangler versions upload.

wrangler triggers deploy [OPTIONS]

• --name string optional
  • Perform on a specific Worker rather than inheriting from the Wrangler configuration file.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

---

deployments

Deployments track the version(s) of your Worker that are actively serving traffic.

Note

The minimum required wrangler version to use these commands is 3.40.0. For versions before 3.73.0, you will need to add the --x-versions flag.

deployments list

Displays the 10 most recent deployments of your Worker

npm

npx wrangler deployments list

pnpm

pnpm wrangler deployments list

yarn

yarn wrangler deployments list

• --name string

  Name of the Worker

• --json boolean default: false

  Display output as clean JSON

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

deployments status

View the current state of your production

npm

npx wrangler deployments status

pnpm

pnpm wrangler deployments status

yarn

yarn wrangler deployments status

• --name string

  Name of the Worker

• --json boolean default: false

  Display output as clean JSON

Global flags

• --v boolean alias: --version

  Show version number

• --cwd string

  Run as if Wrangler was started in the specified directory instead of the current working directory

• --config string alias: --c

  Path to Wrangler configuration file

• --env string alias: --e

  Environment to use for operations, and for selecting .env and .dev.vars files

• --env-file string

  Path to an .env file to load - can be specified multiple times - values from earlier files are overridden by values in later files

• --experimental-remote-bindings boolean aliases: --x-remote-bindings default: true

  Experimental: Enable Remote Bindings

• --experimental-provision boolean aliases: --x-provision

  Experimental: Enable automatic resource provisioning

rollback

Warning

A rollback will immediately create a new deployment with the specified version of your Worker and become the active deployment across all your deployed routes and domains. This change will not affect work in your local development environment.

wrangler rollback [<VERSION_ID>] [OPTIONS]

• VERSION_ID string optional
  • The ID of the version you wish to roll back to. If not supplied, the rollback command defaults to the version uploaded before the latest version.
• --name string optional
  • Perform on a specific Worker rather than inheriting from the Wrangler configuration file.
• --message string optional
  • Add message for rollback. Accepts empty string. When specified, interactive prompts for rollback confirmation and message are skipped.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

---

dispatch namespace

list

List all dispatch namespaces.

wrangler dispatch-namespace list

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

get

Get information about a dispatch namespace.

wrangler dispatch-namespace get <NAME>

• NAME string required
  • The name of the dispatch namespace to get details about.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

create

Create a dispatch namespace.

wrangler dispatch-namespace create <NAME>

• NAME string required
  • The name of the dispatch namespace to create.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

delete

Delete a dispatch namespace.

wrangler dispatch-namespace get <NAME>

Note

You must delete all user Workers in the dispatch namespace before it can be deleted.

• NAME string required
  • The name of the dispatch namespace to delete.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

rename

Rename a dispatch namespace.

wrangler dispatch-namespace get <OLD_NAME> <NEW_NAME>

• OLD_NAME string required
  • The previous name of the dispatch namespace.
• NEW_NAME string required
  • The new name of the dispatch namespace.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

---

mtls-certificate

Manage client certificates used for mTLS connections in subrequests.

These certificates can be used in mtls_certificate bindings, which allow a Worker to present the certificate when establishing a connection with an origin that requires client authentication (mTLS).

upload

Upload a client certificate.

wrangler mtls-certificate upload --cert <PATH> --key <PATH> [OPTIONS]

• --cert string required
  • A path to the TLS certificate to upload. Certificate chains are supported.
• --key string required
  • A path to the private key to upload.
• --name string optional
  • The name assigned to the mTLS certificate at upload.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

The following is an example of using the upload command to upload an mTLS certificate.

npx wrangler mtls-certificate upload --cert cert.pem --key key.pem --name my-origin-cert

Uploading mTLS Certificate my-origin-cert...
Success! Uploaded mTLS Certificate my-origin-cert
ID: 99f5fef1-6cc1-46b8-bd79-44a0d5082b8d
Issuer: CN=my-secured-origin.com,OU=my-team,O=my-org,L=San Francisco,ST=California,C=US
Expires: 1/01/2025

You can then add this certificate as a binding in your Wrangler configuration file:

wrangler.jsonc

{
  "$schema": "./node_modules/wrangler/config-schema.json",
  "mtls_certificates": [
    {
      "binding": "MY_CERT",
      "certificate_id": "99f5fef1-6cc1-46b8-bd79-44a0d5082b8d"
    }
  ]
}

wrangler.toml

mtls_certificates = [
  { binding = "MY_CERT", certificate_id = "99f5fef1-6cc1-46b8-bd79-44a0d5082b8d" }
]

Note that the certificate and private keys must be in separate (typically .pem) files when uploading.

list

List mTLS certificates associated with the current account ID.

wrangler mtls-certificate list

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

The following is an example of using the list command to upload an mTLS certificate.

npx wrangler mtls-certificate list

ID: 99f5fef1-6cc1-46b8-bd79-44a0d5082b8d
Name: my-origin-cert
Issuer: CN=my-secured-origin.com,OU=my-team,O=my-org,L=San Francisco,ST=California,C=US
Created on: 1/01/2023
Expires: 1/01/2025

ID: c5d004d1-8312-402c-b8ed-6194328d5cbe
Issuer: CN=another-origin.com,OU=my-team,O=my-org,L=San Francisco,ST=California,C=US
Created on: 1/01/2023
Expires: 1/01/2025

delete

Delete a client certificate.

wrangler mtls-certificate delete {--id <ID|--name <NAME>}

• --id string
  • The ID of the mTLS certificate.
• --name string
  • The name assigned to the mTLS certificate at upload.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

The following is an example of using the delete command to delete an mTLS certificate.

npx wrangler mtls-certificate delete --id 99f5fef1-6cc1-46b8-bd79-44a0d5082b8d

Are you sure you want to delete certificate 99f5fef1-6cc1-46b8-bd79-44a0d5082b8d (my-origin-cert)? [y/n]
yes
Deleting certificate 99f5fef1-6cc1-46b8-bd79-44a0d5082b8d...
Deleted certificate 99f5fef1-6cc1-46b8-bd79-44a0d5082b8d successfully

---

cert

Manage mTLS client certificates and Certificate Authority (CA) chain certificates used for secured connections.

These certificates can be used in Hyperdrive configurations, enabling them to present the certificate when connecting to an origin database that requires client authentication (mTLS) or a custom Certificate Authority (CA).

upload mtls-certificate

Upload a client certificate.

wrangler cert upload mtls-certificate --cert <PATH> --key <PATH> [OPTIONS]

• --cert string required
  • A path to the TLS certificate to upload. Certificate chains are supported.
• --key string required
  • A path to the private key to upload.
• --name string optional
  • The name assigned to the mTLS certificate at upload.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

The following is an example of using the upload command to upload an mTLS certificate.

npx wrangler cert upload --cert cert.pem --key key.pem --name my-origin-cert

Uploading mTLS Certificate my-origin-cert...
Success! Uploaded mTLS Certificate my-origin-cert
ID: 99f5fef1-6cc1-46b8-bd79-44a0d5082b8d
Issuer: CN=my-secured-origin.com,OU=my-team,O=my-org,L=San Francisco,ST=California,C=US
Expires: 1/01/2025

Note that the certificate and private keys must be in separate (typically .pem) files when uploading.

upload certificate-authority

Upload a client certificate.

wrangler cert upload certificate-authority --ca-cert <PATH> [OPTIONS]

• --ca-cert string required

  • A path to the Certificate Authority (CA) chain certificate to upload.

• --name string optional

  • The name assigned to the mTLS certificate at upload.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

The following is an example of using the upload command to upload an CA certificate.

npx wrangler cert upload certificate-authority --ca-cert server-ca-chain.pem --name SERVER_CA_CHAIN

Uploading CA Certificate SERVER_CA_CHAIN...
Success! Uploaded CA Certificate SERVER_CA_CHAIN
ID: 99f5fef1-6cc1-46b8-bd79-44a0d5082b8d
Issuer: CN=my-secured-origin.com,OU=my-team,O=my-org,L=San Francisco,ST=California,C=US
Expires: 1/01/2025

list

List mTLS certificates associated with the current account ID. This will display both mTLS certificates and CA certificates.

wrangler cert list

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

The following is an example of using the list command to upload an mTLS or CA certificate.

npx wrangler cert list

ID: 99f5fef1-6cc1-46b8-bd79-44a0d5082b8d
Name: my-origin-cert
Issuer: CN=my-secured-origin.com,OU=my-team,O=my-org,L=San Francisco,ST=California,C=US
Created on: 1/01/2023
Expires: 1/01/2025

ID: c5d004d1-8312-402c-b8ed-6194328d5cbe
Issuer: CN=another-origin.com,OU=my-team,O=my-org,L=San Francisco,ST=California,C=US
Created on: 1/01/2023
Expires: 1/01/2025

delete

Delete a client certificate.

wrangler cert delete {--id <ID|--name <NAME>}

• --id string
  • The ID of the mTLS or CA certificate.
• --name string
  • The name assigned to the mTLS or CA certificate at upload.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

The following is an example of using the delete command to delete an mTLS or CA certificate.

npx wrangler cert delete --id 99f5fef1-6cc1-46b8-bd79-44a0d5082b8d

Are you sure you want to delete certificate 99f5fef1-6cc1-46b8-bd79-44a0d5082b8d (my-origin-cert)? [y/n]
yes
Deleting certificate 99f5fef1-6cc1-46b8-bd79-44a0d5082b8d...
Deleted certificate 99f5fef1-6cc1-46b8-bd79-44a0d5082b8d successfully

---

types

Generate types based on your Worker configuration, including Env types based on your bindings, module rules, and runtime types based on thecompatibility_date and compatibility_flags in your config file.

wrangler types [<PATH>] [OPTIONS]

Note

If you are running a version of Wrangler that is greater than 3.66.0 but below 4.0.0, you will need to include the --experimental-include-runtime flag. During its experimental release, runtime types were output to a separate file (.wrangler/types/runtime.d.ts by default). If you have an older version of Wrangler, you can access runtime types through the @cloudflare/workers-types package.

• PATH string (default: `./worker-configuration.d.ts`)
  • The path to where types for your Worker will be written.
  • The path must have a d.ts extension.
• --env-interface string (default: `Env`)
  • The name of the interface to generate for the environment object.
  • Not valid if the Worker uses the Service Worker syntax.
• --include-runtime boolean (default: true)
  • Whether to generate runtime types based on thecompatibility_date and compatibility_flags in your config file.
• --include-env boolean (default: true)
  • Whether to generate Env types based on your Worker bindings.
• --strict-vars boolean optional (default: true)
  • Control the types that Wrangler generates for vars bindings.
  • If true, (the default) Wrangler generates literal and union types for bindings (e.g. myVar: 'my dev variable' | 'my prod variable').
  • If false, Wrangler generates generic types (e.g. myVar: string). This is useful when variables change frequently, especially when working across multiple environments.
• --config, -c string[] optional
  • Path(s) to Wrangler configuration file. If the Worker you are generating types for has service bindings or bindings to Durable Objects, you can also provide the paths to those configuration files so that the generated Env type will include RPC types. For example, given a Worker with a service binding, wrangler types -c wrangler.toml -c ../bound-worker/wrangler.toml will generate an Env type like this:

  TypeScript

  interface Env {
    SERVICE_BINDING: Service<import("../bound-worker/src/index").Entrypoint>;
  }

---

telemetry

Cloudflare collects anonymous usage data to improve Wrangler. You can learn more about this in our data policy ↗.

You can manage sharing of usage data at any time using these commands.

disable

Disable telemetry collection for Wrangler.

wrangler telemetry disable

enable

Enable telemetry collection for Wrangler.

wrangler telemetry enable

status

Check whether telemetry collection is currently enabled. The return result is specific to the directory where you have run the command.

This will resolve the global status set by wrangler telemetry disable / enable, the environment variable WRANGLER_SEND_METRICS, and the send_metrics key in the Wrangler configuration file.

wrangler telemetry status

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.

---

check

startup

Generate a CPU profile of your Worker's startup phase.

After you run wrangler check startup, you can import the profile into Chrome DevTools or open it directly in VSCode to view a flamegraph of your Worker's startup phase. Additionally, when a Worker deployment fails with a startup time error Wrangler will automatically generate a CPU profile for easy investigation.

Note

This command measures performance of your Worker locally, on your own machine — which has a different CPU than when your Worker runs on Cloudflare. This means results can vary widely.

You should use the CPU profile that wrangler check startup generates in order to understand where time is spent at startup, but you should not expect the overall startup time in the profile to match exactly what your Worker's startup time will be when deploying to Cloudflare.

wrangler check startup

• --args string optional
  • To customise the way wrangler check startup builds your Worker for analysis, provide the exact arguments you use when deploying your Worker with wrangler deploy, or your Pages project with wrangler pages functions build. For instance, if you deploy your Worker with wrangler deploy --no-bundle, you should use wrangler check startup --args="--no-bundle" to profile the startup phase.
• --worker string optional
  • If you don't use Wrangler to deploy your Worker, you can use this argument to provide a Worker bundle to analyse. This should be a file path to a serialized multipart upload, with the exact same format as the API expects.
• --pages boolean optional
  • If you don't use a Wrangler config file with your Pages project (i.e. a Wrangler config file containing pages_build_output_dir), use this flag to force wrangler check startup to treat your project as a Pages project.

The following global flags work on every command:

• --help boolean
  • Show help.
• --config string (not supported by Pages)
  • Path to your Wrangler configuration file.
• --cwd string
  • Run as if Wrangler was started in the specified directory instead of the current working directory.