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.
• generate - Create a Wrangler project using an existing Workers template ↗.
• 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.
• publish - Publish your Worker to Cloudflare.
• 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.
• secret - Manage the secret variables for a Worker.
• secret:bulk - Manage multiple secret variables for a Worker.
• workflows - Manage and configure Workflows.
• tail - Start a session to livestream logs from a deployed Worker.
• pages - Configure Cloudflare Pages.
• 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.
• types - Generate types from bindings and module rules in configuration.
• telemetry - Configure whether Wrangler can collect anonymous usage data.

Note

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

---

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.

wrangler docs [<COMMAND>]

• COMMAND string optional
  • The Wrangler command you want to learn more about. This opens your default browser to the section of the documentation that describes the command.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

init

Note

The init command will be removed in a future version. Please use npm create cloudflare@latest instead.

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.toml configuration file.
• --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.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

---

generate

Note

This command has been deprecated as of Wrangler v3 and will be removed in a future version.

Create a new project using an existing Workers template ↗.

wrangler generate [<NAME>] [TEMPLATE]

• 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.toml configuration file.
• TEMPLATE string optional
  • The URL of a GitHub template, with a default worker-template ↗. Browse a list of available templates on the cloudflare/workers-sdk ↗ repository.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

---

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.toml 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 wrangler dev --remote.
• --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 Wrangler.toml).
• --batch-size number optional
  • Number of queries to send in a single batch.

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.
• --remote boolean (default: false) optional
  • Execute commands/files against a remote D1 database for use with wrangler dev --remote.
• --output string optional
  • 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.

backup create

Warning

This command only works on databases created during D1's alpha period. You can check which version your database uses with wrangler d1 info <DATABASE_NAME>.

This command will not work on databases that are created during the beta period, or after general availability (GA). Refer to Time Travel in the D1 documentation for more information on D1's approach to backup and restores for databases created during the beta/GA period.

Initiate a D1 backup.

wrangler d1 backup create <DATABASE_NAME>

• DATABASE_NAME string required
  • The name of the D1 database to backup.

backup list

Warning

This command only works on databases created during D1's alpha period. You can check which version your database uses with wrangler d1 info <DATABASE_NAME>.

This command will not work on databases that are created during the beta period, or after general availability (GA). Refer to Time Travel in the D1 documentation for more information on D1's approach to backup and restores for databases created during the beta/GA period.

List all available backups.

wrangler d1 backup list <DATABASE_NAME>

• DATABASE_NAME string required
  • The name of the D1 database to list the backups of.

backup restore

Warning

This command only works on databases created during D1's alpha period. You can check which version your database uses with wrangler d1 info <DATABASE_NAME>.

This command will not work on databases that are created during the beta period, or after general availability (GA). Refer to Time Travel in the D1 documentation for more information on D1's approach to backup and restores for databases created during the beta/GA period.

Restore a backup into a D1 database.

wrangler d1 backup restore <DATABASE_NAME> <BACKUP_ID>

• DATABASE_NAME string required
  • The name of the D1 database to restore the backup into.
• BACKUP_ID string required
  • The ID of the backup you wish to restore.

backup download

Warning

This command only works on databases created during D1's alpha period. You can check which version your database uses with wrangler d1 info <DATABASE_NAME>.

This command will not work on databases that are created during the beta period, or after general availability (GA). To download existing data of a beta/GA database to your local machine refer to the wrangler d1 export command. Refer to Time Travel in the D1 documentation for more information on D1's approach to backups for databases created during the beta/GA period.

Download existing data to your local machine.

wrangler d1 backup download <DATABASE_NAME> <BACKUP_ID>

• DATABASE_NAME string required
  • The name of the D1 database you wish to download the backup of.
• BACKUP_ID string required
  • The ID of the backup you wish to download.
• --output string optional
  • The .sqlite3 file to write to (defaults to '<DB_NAME>.<SHORT_BACKUP_ID>.sqlite3').

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 wrangler.toml).

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 wrangler.toml).
• --batch-size number optional
  • Number of queries to send in a single batch.

---

hyperdrive

Manage Hyperdrive database configurations.

create

Create a new Hyperdrive configuration.

wrangler hyperdrive create <CONFIG_NAME> [OPTIONS]

• CONFIG_NAME string required
  • The name of the Hyperdrive configuration to create.
• --connection-string string optional
  • The database connection string in the form postgres://user:password@hostname:port/database.
• --origin-host string optional
  • The hostname or IP address Hyperdrive should connect to.
• --origin-port number optional
  • The database port to connect to.
• --origin-scheme string optional
  • The scheme used to connect to the origin database, for example, postgresql or postgres.
• --database string optional
  • The database (name) to connect to. For example, Postgres or defaultdb.
• --origin-user string optional
  • The username used to authenticate to the database.
• --origin-password string optional
  • The password used to authenticate to the database.
• --access-client-id string optional
  • The Client ID of the Access token to use when connecting to the origin database, must be set with a Client Access Secret. Mutually exclusive with origin-port.
• --access-client-secret string optional
  • The Client Secret of the Access token to use when connecting to the origin database, must be set with a Client Access ID. Mutually exclusive with origin-port.
• --caching-disabled boolean optional
  • Disables the caching of SQL responses.
• --max-age number optional
  • Specifies max duration for which items should persist in the cache, cannot be set when caching is disabled.
• --swr number optional
  • Stale While Revalidate - Indicates the number of seconds cache may serve the response after it becomes stale, cannot be set when caching is disabled.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

update

Update an existing Hyperdrive configuration.

wrangler hyperdrive update <ID> [OPTIONS]

• ID string required
  • The ID of the Hyperdrive configuration to update.
• --name string optional
  • The new name of the Hyperdrive configuration.
• --connection-string string optional
  • The database connection string in the form postgres://user:password@hostname:port/database.
• --origin-host string optional
  • The new database hostname or IP address Hyperdrive should connect to.
• --origin-port string optional
  • The new database port to connect to.
• --origin-scheme string optional
  • The scheme used to connect to the origin database, for example, postgresql or postgres.
• --database string optional
  • The new database (name) to connect to. For example, Postgres or defaultdb.
• --origin-user string optional
  • The new username used to authenticate to the database.
• --origin-password string optional
  • The new password used to authenticate to the database.
• --access-client-id string optional
  • The Client ID of the Access token to use when connecting to the origin database, must be set with a Client Access Secret. Mutually exclusive with origin-port.
• --access-client-secret string optional
  • The Client Secret of the Access token to use when connecting to the origin database, must be set with a Client Access ID. Mutually exclusive with origin-port.
• --caching-disabled boolean optional
  • Disables the caching of SQL responses.
• --max-age number optional
  • Specifies max duration for which items should persist in the cache, cannot be set when caching is disabled.
• --swr number optional
  • Stale While Revalidate - Indicates the number of seconds cache may serve the response after it becomes stale, cannot be set when caching is disabled.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

list

List all Hyperdrive configurations.

wrangler hyperdrive list

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

delete

Delete an existing Hyperdrive configuration.

wrangler hyperdrive delete <ID>

• ID string required
  • The name of the Hyperdrive configuration to delete.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

get

Get an existing Hyperdrive configuration.

wrangler hyperdrive get <ID>

• ID string required
  • The name of the Hyperdrive configuration to get.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

---

vectorize

Interact with a Vectorize vector database.

create

Creates a new vector index, and provides the binding and name that you will put in your wrangler.toml file.

npx wrangler vectorize create <INDEX_NAME> [--dimensions=<NUM_DIMENSIONS>] [--metric=<DISTANCE_METRIC>] [--description=<DESCRIPTION>]

• INDEX_NAME string required
  • The name of the new index to create. Must be unique for an account and cannot be changed after creation.
• --dimensions number required
  • The vector dimension width to configure the index for. Cannot be changed after creation.
• --metric string required
  • The distance metric to use for calculating vector distance. Must be one of cosine, euclidean, or dot-product.
• --description string optional
  • A description for your index.
• --deprecated-v1 boolean optional
  • Create a legacy Vectorize index. Please note that legacy Vectorize indexes are on a deprecation path.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

list

List all Vectorize indexes in your account, including the configured dimensions and distance metric.

npx wrangler vectorize list

• --deprecated-v1 boolean optional
  • List legacy Vectorize indexes. Please note that legacy Vectorize indexes are on a deprecation path.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

get

Get details about an individual index, including its configuration.

npx wrangler vectorize get <INDEX_NAME>

• INDEX_NAME string required
  • The name of the index to fetch details for.
• --deprecated-v1 boolean optional
  • Get a legacy Vectorize index. Please note that legacy Vectorize indexes are on a deprecation path.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

info

Get some additional information about an individual index, including the vector count and details about the last processed mutation.

npx wrangler vectorize info <INDEX_NAME>

• INDEX_NAME string required
  • The name of the index to fetch details for.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

delete

Delete a Vectorize index.

npx wrangler vectorize delete <INDEX_NAME> [OPTIONS]

• INDEX_NAME string required
  • The name of the Vectorize index to delete.
• --force boolean optional
  • Skip confirmation when deleting the index (Note: This is not a recoverable operation).
• --deprecated-v1 boolean optional
  • Delete a legacy Vectorize index. Please note that legacy Vectorize indexes are on a deprecation path.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

insert

Insert vectors into an index.

npx wrangler vectorize insert <INDEX_NAME> [OPTIONS]

• INDEX_NAME string required
  • The name of the Vectorize index to upsert vectors in.
• --file string required
  • A file containing the vectors to insert in newline-delimited JSON (JSON) format.
• --batch-size number optional
  • The number of vectors to insert at a time (default: 1000).
• --deprecated-v1 boolean optional
  • Insert into a legacy Vectorize index. Please note that legacy Vectorize indexes are on a deprecation path.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

upsert

Upsert vectors into an index. Existing vectors in the index would be overwritten.

npx wrangler vectorize upsert <INDEX_NAME> [OPTIONS]

• INDEX_NAME string required
  • The name of the Vectorize index to upsert vectors in.
• --file string required
  • A file containing the vectors to insert in newline-delimited JSON (JSON) format.
• --batch-size number optional
  • The number of vectors to insert at a time (default: 5000).

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

query

Query a Vectorize index for similar vectors.

npx wrangler vectorize query <INDEX_NAME> [OPTIONS]

• INDEX_NAME string required
  • The name of the Vectorize index to query.
• --vector array optional
  • Vector against which the Vectorize index is queried. Either this or the vector-id param must be provided.
• --vector-id string optional
  • Identifier for a vector that is already present in the index against which the index is queried. Either this or the vector param must be provided.
• --top-k number optional
  • The number of vectors to query (default: 5).
• --return-values boolean optional
  • Enable to return vector values in the response (default: false).
• --return-metadata string optional
  • Enable to return vector metadata in the response. Must be one of none, indexed, or all (default: none).
• --namespace string optional
  • Query response to only include vectors from this namespace.
• --filter string optional
  • Filter vectors based on this metadata filter. Example: '{ 'p1': 'abc', 'p2': { '$ne': true }, 'p3': 10, 'p4': false, 'nested.p5': 'abcd' }'

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

get-vectors

Fetch vectors from a Vectorize index using the provided ids.

npx wrangler vectorize get-vectors <INDEX_NAME> [OPTIONS]

• INDEX_NAME string required
  • The name of the Vectorize index from which vectors need to be fetched.
• --ids array required
  • List of ids for which vectors must be fetched.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

delete-vectors

Delete vectors in a Vectorize index using the provided ids.

npx wrangler vectorize delete-vectors <INDEX_NAME> [OPTIONS]

• INDEX_NAME string required
  • The name of the Vectorize index from which vectors need to be deleted.
• --ids array required
  • List of ids corresponding to the vectors that must be deleted.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

create-metadata-index

Enable metadata filtering on the specified property.

npx wrangler vectorize create-metadata-index <INDEX_NAME> [OPTIONS]

• INDEX_NAME string required
  • The name of the Vectorize index for which metadata index needs to be created.
• --property-name string required
  • Metadata property for which metadata filtering should be enabled.
• --type string required
  • Data type of the property. Must be one of string, number, or boolean.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

list-metadata-index

List metadata properties on which metadata filtering is enabled.

npx wrangler vectorize list-metadata-index <INDEX_NAME> [OPTIONS]

• INDEX_NAME string required
  • The name of the Vectorize index for which metadata indexes needs to be fetched.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

delete-metadata-index

Disable metadata filtering on the specified property.

npx wrangler vectorize delete-metadata-index <INDEX_NAME> [OPTIONS]

• INDEX_NAME string required
  • The name of the Vectorize index for which metadata index needs to be disabled.
• --property-name string required
  • Metadata property for which metadata filtering should be disabled.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

---

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.toml file. Refer to the wrangler.toml configuration documentation for more information.

Warning

As of Wrangler v3.2.0, wrangler dev is supported by any Linux distributions providing glibc 2.31 or higher (e.g. Ubuntu 20.04/22.04, Debian 11/12, Fedora 37/38/39), macOS version 11 or higher, and Windows (x86-64 architecture).

• SCRIPT string
  • The path to an entry point for your Worker. Only required if your wrangler.toml does not include a main key (for example, main = "index.js").
• --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.
• --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.
• --legacy-assets string optional deprecated, use `--assets`
  • Folder of static assets to be served.
• --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.toml. 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.toml. 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.
• --node-compat boolean optional
  • Enable Node.js compatibility.
• --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=*+*+*+*+*.
• --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.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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 [<SCRIPT>] [OPTIONS]

Note

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

• SCRIPT string
  • The path to an entry point for your Worker. Only required if your wrangler.toml does not include a main key (for example, main = "index.js").
• --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.
• --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.
• --legacy-assets string optional deprecated, use `--assets`
  • Folder of static assets to be served.
• --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.toml. 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.toml. 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.
• --node-compat boolean optional
  • Enable node.js compatibility.
• --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 or bindings 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.
• --dispatch-namespace string optional
  • Specify the Workers for Platforms dispatch namespace to upload this Worker to.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

---

publish

Publish your Worker to Cloudflare.

wrangler publish [OPTIONS]

Note

This command has been deprecated as of v3 in favor of wrangler deploy. It will be removed in v4.

---

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.toml 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.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.

create

Create a new namespace.

wrangler kv namespace create <NAMESPACE> [OPTIONS]

• NAMESPACE string required
  • The name of the new namespace.
• --env string optional
  • Perform on a specific environment.
• --preview boolean optional
  • Interact with a preview namespace (the preview_id value).

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

The following is an example of using the create command to create a KV namespace called MY_KV.

npx wrangler kv namespace create "MY_KV"

🌀 Creating namespace with title "worker-MY_KV"
✨ Success!
Add the following to your configuration file in your kv_namespaces array:
kv_namespaces = [
  { binding = "MY_KV", id = "e29b263ab50e42ce9b637fa8370175e8" }
]

The following is an example of using the create command to create a preview KV namespace called MY_KV.

npx wrangler kv namespace create "MY_KV" --preview

🌀 Creating namespace with title "my-site-MY_KV_preview"
✨ Success!
Add the following to your configuration file in your kv_namespaces array:
kv_namespaces = [
  { binding = "MY_KV", preview_id = "15137f8edf6c09742227e99b08aaf273" }
]

list

List all KV namespaces associated with the current account ID.

wrangler kv namespace list

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

The following is an example that passes the Wrangler command through the jq command:

npx wrangler kv namespace list | jq "."

[
  {
    "id": "06779da6940b431db6e566b4846d64db",
    "title": "TEST_NAMESPACE"
  },
  {
    "id": "32ac1b3c2ed34ed3b397268817dea9ea",
    "title": "STATIC_CONTENT"
  }
]

delete

Delete a given namespace.

wrangler kv namespace delete {--binding=<BINDING>|--namespace-id=<NAMESPACE_ID>} [OPTIONS]

Warning

This command requires --binding or --namespace-id.

• --binding string
  • The binding name of the namespace, as stored in the wrangler.toml file, to delete.
• --namespace-id string
  • The ID of the namespace to delete.
• --env string optional
  • Perform on a specific environment.
• --preview boolean optional
  • Interact with a preview namespace instead of production.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

The following is an example of deleting a KV namespace called MY_KV.

npx wrangler kv namespace delete --binding=MY_KV

Are you sure you want to delete namespace f7b02e7fc70443149ac906dd81ec1791? [y/n]
yes
Deleting namespace f7b02e7fc70443149ac906dd81ec1791
Deleted namespace f7b02e7fc70443149ac906dd81ec1791

The following is an example of deleting a preview KV namespace called MY_KV.

npx wrangler kv namespace delete --binding=MY_KV --preview

Are you sure you want to delete namespace 15137f8edf6c09742227e99b08aaf273? [y/n]
yes
Deleting namespace 15137f8edf6c09742227e99b08aaf273
Deleted namespace 15137f8edf6c09742227e99b08aaf273

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.

put

Write a single key-value pair to a particular namespace.

wrangler kv key put <KEY> {<VALUE>|--path=<PATH>} {--binding=<BINDING>|--namespace-id=<NAMESPACE_ID>} [OPTIONS]

Warning

This command requires a VALUE or --path.
This command requires a --binding or --namespace-id flag.

• KEY string required
  • The key to write to.
• VALUE string optional
  • The value to write.
• --path optional
  • When defined, the value is loaded from the file at --path rather than reading it from the VALUE argument. This is ideal for security-sensitive operations because it avoids saving keys and values into your terminal history.
• --binding string
  • The binding name of the namespace, as stored in the wrangler.toml file, to write to.
• --namespace-id string
  • The ID of the namespace to write to.
• --env string optional
  • Perform on a specific environment.
• --preview boolean optional
  • Interact with a preview namespace instead of production.
• --ttl number optional
  • The lifetime (in number of seconds) that the key-value pair should exist before expiring. Must be at least 60 seconds. This option takes precedence over the expiration option.
• --expiration number optional
  • The timestamp, in UNIX seconds, indicating when the key-value pair should expire.
• --metadata string optional
  • Any (escaped) JSON serialized arbitrary object to a maximum of 1024 bytes.
• --local boolean optional
  • Interact with locally persisted data.
• --persist-to string optional
  • Specify directory for locally persisted data.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

The following is an example that puts a key-value into the namespace with binding name of MY_KV.

npx wrangler kv key put --binding=MY_KV "my-key" "some-value"

Writing the value "some-value" to key "my-key" on namespace f7b02e7fc70443149ac906dd81ec1791.

The following is an example that puts a key-value into the preview namespace with binding name of MY_KV.

npx wrangler kv key put --binding=MY_KV --preview "my-key" "some-value"

Writing the value "some-value" to key "my-key" on namespace 15137f8edf6c09742227e99b08aaf273.

The following is an example that puts a key-value into a namespace, with a time-to-live value of 10000 seconds.

npx wrangler kv key put --binding=MY_KV "my-key" "some-value" --ttl=10000

Writing the value "some-value" to key "my-key" on namespace f7b02e7fc70443149ac906dd81ec1791.

The following is an example that puts a key-value into a namespace, where the value is read from the value.txt file.

npx wrangler kv key put --binding=MY_KV "my-key" --path=value.txt

Writing the contents of value.txt to the key "my-key" on namespace f7b02e7fc70443149ac906dd81ec1791.

list

Output a list of all keys in a given namespace.

wrangler kv key list {--binding=<BINDING>|--namespace-id=<NAMESPACE_ID>} [OPTIONS]

Warning

This command requires --binding or --namespace-id.

• --binding string
  • The binding name of the namespace, as stored in the wrangler.toml file, to list from.
• --namespace-id string
  • The ID of the namespace to list from.
• --env string optional
  • Perform on a specific environment.
• --preview boolean optional
  • Interact with a preview namespace instead of production.
• --prefix string optional
  • Only list keys that begin with the given prefix.
• --local boolean optional
  • Interact with locally persisted data.
• --persist-to string optional
  • Specify directory for locally persisted data.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

Below is an example that passes the Wrangler command through the jq command:

npx wrangler kv key list --binding=MY_KV --prefix="public" | jq "."

[
  {
    "name": "public_key"
  },
  {
    "name": "public_key_with_expiration",
    "expiration": "2019-09-10T23:18:58Z"
  }
]

get

Read a single value by key from the given namespace.

wrangler kv key get <KEY> {--binding=<BINDING>|--namespace-id=<NAMESPACE_ID>} [OPTIONS]

Warning

Exactly one of --binding or --namespace-id is required.

• KEY string required
  • The key value to get.
• --binding string
  • The binding name of the namespace, as stored in the wrangler.toml file, to get from.
• --namespace-id string
  • The ID of the namespace to get from.
• --env string optional
  • Perform on a specific environment.
• --preview boolean optional
  • Interact with a preview namespace instead of production.
• --text boolean optional
  • Decode the returned value as a UTF-8 string.
• --local boolean optional
  • Interact with locally persisted data.
• --persist-to string optional
  • Specify directory for locally persisted data.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

The following is an example that gets the value of the "my-key" key from the KV namespace with binding name MY_KV.

npx wrangler kv key get --binding=MY_KV "my-key"

value

delete

Remove a single key value pair from the given namespace.

wrangler kv key delete <KEY> {--binding=<BINDING>|--namespace-id=<NAMESPACE_ID>} [OPTIONS]

Warning

Exactly one of --binding or --namespace-id is required.

• KEY string required
  • The key value to get.
• --binding string
  • The binding name of the namespace, as stored in the wrangler.toml file, to delete from.
• --namespace-id string
  • The ID of the namespace to delete from.
• --env string optional
  • Perform on a specific environment.
• --preview boolean optional
  • Interact with a preview namespace instead of production.
• --local boolean optional
  • Interact with locally persisted data.
• --persist-to string optional
  • Specify directory for locally persisted data.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

The following is an example that deletes the key-value pair with key "my-key" from the KV namespace with binding name MY_KV.

npx wrangler kv key delete --binding=MY_KV "my-key"

Deleting the key "my-key" on namespace f7b02e7fc70443149ac906dd81ec1791.

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.

put

Write a JSON file containing an array of key-value pairs to the given namespace.

wrangler kv bulk put <FILENAME> {--binding=<BINDING>|--namespace-id=<NAMESPACE_ID>} [OPTIONS]

Warning

This command requires --binding or --namespace-id.

• FILENAME string required
  • The JSON file containing an array of key-value pairs to write to the namespace.
• --binding string
  • The binding name of the namespace, as stored in the wrangler.toml file, to write to.
• --namespace-id string
  • The ID of the namespace to write to.
• --env string optional
  • Perform on a specific environment.
• --preview boolean optional
  • Interact with a preview namespace instead of production.
• --local boolean optional
  • Interact with locally persisted data.
• --persist-to string optional
  • Specify directory for locally persisted data.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

This command takes a JSON file as an argument with a list of key-value pairs to upload. An example of JSON input:

[
  {
    "key": "test_key",
    "value": "test_value",
    "expiration_ttl": 3600
  }
]

KV namespace values can only store strings. In order to save complex a value, stringify it to JSON:

[
  {
    "key": "test_key",
    "value": "{\"name\": \"test_value\"}",
    "expiration_ttl": 3600
  }
]

Refer to the full schema for key-value entries uploaded via the bulk API:

• key string required
  • The key’s name. The name may be 512 bytes maximum. All printable, non-whitespace characters are valid.
• value string required
  • The UTF-8 encoded string to be stored, up to 25 MB in length.
• metadata object optional
  • Any arbitrary object (must serialize to JSON) to a maximum of 1,024 bytes.
• expiration number optional
  • The time, measured in number of seconds since the UNIX epoch, at which the key should expire.
• expiration_ttl number optional
  • The number of seconds the document should exist before expiring. Must be at least 60 seconds.
• base64 boolean optional
  • When true, the server will decode the value as base64 before storing it. This is useful for writing values that would otherwise be invalid JSON strings, such as images. Defaults to false.

Note

If both expiration and expiration_ttl are specified for a given key, the API will prefer expiration_ttl.

The following is an example of writing all the key-value pairs found in the allthethingsupload.json file.

npx wrangler kv bulk put --binding=MY_KV allthethingsupload.json

Success!

delete

Delete all keys read from a JSON file within a given namespace.

wrangler kv bulk delete <FILENAME> {--binding=<BINDING>|--namespace-id=<NAMESPACE_ID>} [OPTIONS]

Warning

This command requires --binding or --namespace-id.

• FILENAME string required
  • The JSON file containing an array of keys to delete from the namespace.
• --binding string
  • The binding name of the namespace, as stored in the wrangler.toml file, to delete from.
• --namespace-id string
  • The ID of the namespace to delete from.
• --env string optional
  • Perform on a specific environment.
• --preview boolean optional
  • Interact with a preview namespace instead of production.
• --local boolean optional
  • Interact with locally persisted data.
• --persist-to string optional
  • Specify directory for locally persisted data.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

This command takes a JSON file as an argument containing an array of keys to delete.

The following is an example of the JSON input:

["test_key_1", "test_key_2"]

The following is an example of deleting all the keys found in the allthethingsdelete.json file.

npx wrangler kv bulk delete --binding=MY_KV allthethingsdelete.json

? Are you sure you want to delete all keys in allthethingsdelete.json from kv-namespace with id "f7b02e7fc70443149ac906dd81ec1791"? › (Y/n)
Success!

---

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.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

delete

Delete an R2 bucket.

wrangler r2 bucket delete <NAME>

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

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

list

List R2 bucket in the current account.

wrangler r2 bucket list

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.
• --id string optional
  • A unique identifier for the lifecycle rule.
• --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.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.
• --id string required
  • The unique identifier 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.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

---

r2 object

Interact with R2 objects.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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 optional
  • Interact with locally persisted data.
• --persist-to string optional
  • Specify directory for locally persisted data.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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 optional
  • Interact with locally persisted data.
• --persist-to string optional
  • Specify directory for locally persisted data.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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 optional
  • Interact with locally persisted data.
• --persist-to string optional
  • Specify directory for locally persisted data.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

---

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 wrangler.toml.
• --env string optional
  • Perform on a specific environment.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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 wrangler.toml.
• --env string optional
  • Perform on a specific environment.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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 wrangler.toml.
• --env string optional
  • Perform on a specific environment

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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
  • The JSON 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 wrangler.toml.
• --env string optional
  • Perform on a specific environment.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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

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.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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 required
  • The ID of a Workflow instance. You can optionally provide latest to refer to the most recently created instance of a Workflow.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

# 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.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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

tail

Start a session to livestream logs from a deployed Worker.

wrangler tail <WORKER> [OPTIONS]

• WORKER string required
  • The name of your Worker or the route the Worker is running on.
• --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 fraction of requests to log sampling rate (between 0 and 1).
• --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.
• --version-id string optional
  • Filter by Worker version.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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).
• --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.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

download config

Download your Pages project config as a wrangler.toml file.

wrangler pages download config <PROJECT_NAME>

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

project list

List your Pages projects.

wrangler pages project list

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.toml 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.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.

publish

Publish a directory of static assets as a Pages deployment.

wrangler pages publish [<DIRECTORY>] [OPTIONS]

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

Note

This command has been deprecated as of v3 in favor of wrangler pages deploy. It will be removed in v4.

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.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

secret bulk

Upload multiple secrets for a Pages project at once.

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

• FILENAME string optional
  • The JSON 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.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

---

queues

Manage your Workers Queues configurations.

create

Create a new Queue.

wrangler queues create <name> [OPTIONS]

• name string required
  • The name of the queue to create.
• --delivery-delay-secs number optional
  • How long a published message should be delayed for, in seconds. Must be a positive integer.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

delete

Delete an existing queue.

wrangler queues delete <name> [OPTIONS]

• name string required
  • The name of the queue to delete.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

list

List all queues in the current account.

wrangler queues list [OPTIONS]

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

info

Get information on individual queues.

wrangler queues info <name>

• name string required
  • The name of the queue to inspect.

consumer

Manage queue consumer configurations.

consumer add <script-name>

Add a Worker script as a queue consumer.

wrangler queues consumer add <queue-name> <script-name> [OPTIONS]

• queue-name string required
  • The name of the queue to add the consumer to.
• script-name string required
  • The name of the Workers script to add as a consumer of the named queue.
• --batch-size number optional
  • Maximum number of messages per batch. Must be a positive integer.
• --batch-timeout number optional
  • Maximum number of seconds to wait to fill a batch with messages. Must be a positive integer.
• --message-retries number optional
  • Maximum number of retries for each message. Must be a positive integer.
• --max-concurrency number optional
  • The maximum number of concurrent consumer invocations that will be scaled up to handle incoming message volume. Must be a positive integer.
• --retry-delay-secs number optional
  • How long a retried message should be delayed for, in seconds. Must be a positive integer.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

consumer remove

Remove a consumer from a queue.

wrangler queues consumer remove <queue-name> <script-name>

• queue-name string required
  • The name of the queue to remove the consumer from.
• script-name string required
  • The name of the Workers script to remove as the consumer.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

---

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 $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.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

Note

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

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.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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

1. Log in to the Cloudflare dashboard ↗.
2. Go to My Profile > API Tokens.
3. Select the three-dot menu on your Wrangler token.
4. Select Delete.

---

whoami

Retrieve your user information and test your authentication configuration.

wrangler whoami

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

---

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.

upload

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

wrangler versions upload [OPTIONS]

• --tag string optional
  • Add a version tag. Accepts empty string.
• --message string optional
  • Add a version message. Accepts empty string.
• --name string optional
  • Perform on a specific Worker rather than inheriting from wrangler.toml.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.

wrangler versions deploy [OPTIONS]

• --name string optional
  • Perform on a specific Worker rather than inheriting from wrangler.toml.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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

list

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

wrangler versions list [OPTIONS]

• --name string optional
  • Perform on a specific Worker rather than inheriting from wrangler.toml.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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 wrangler.toml.
• --env string optional
  • Perform on a specific environment.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

secret delete

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

wrangler versions 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 wrangler.toml.
• --env string optional
  • Perform on a specific environment.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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
  • The JSON 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 wrangler.toml.
• --env string optional
  • Perform on a specific environment.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

---

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 wrangler.toml.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

---

deployments

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

list

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.

Retrieve details for the 10 most recent deployments. Details include Created on, Author, Source, an optional Message, and metadata about the Version(s) in the deployment.

wrangler deployments list [OPTIONS]

• --name string optional
  • Perform on a specific Worker rather than inheriting from wrangler.toml.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

status

Retrieve details for the most recent deployment. Details include Created on, Author, Source, an optional Message, and metadata about the Version(s) in the deployment.

wrangler deployments status

• --name string optional
  • Perform on a specific Worker rather than inheriting from wrangler.toml.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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 wrangler.toml.
• --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.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

---

dispatch namespace

list

List all dispatch namespaces.

wrangler dispatch-namespace list

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

---

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.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.toml:

wrangler.toml

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

wrangler.json

{
  "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.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

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

---

types

Generate types from bindings and module rules in configuration.

wrangler types [<PATH>] [OPTIONS]

Note

The --experimental-include-runtime flag dynamically generates runtime types according to the compatibility_date and compatibility_flags defined in your config file.

It is a replacement for the @cloudflare/workers-types package ↗, so that package, if installed, should be uninstalled to avoid any potential conflict.

After running the command, you must add the path of the generated runtime types file to the compilerOptions.types field ↗ in your project's tsconfig.json ↗ file.

You may use the shorthand --x-include-runtime flag in place of --experimental-include-runtime anywhere it is mentioned.

The minimum required Wrangler version to use this command is 3.66.0.

• PATH string (default: `./worker-configuration.d.ts`)
  • The path to where the Env 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.
• --experimental-include-runtime string optional (default: `./.wrangler/types/runtime.d.ts`)
  • The path to where the runtime types file will be written.
  • Leave the path blank to use the default option, e.g. npx wrangler types --x-include-runtime
  • A custom path must be relative to the project root, e.g. ./my-runtime-types.d.ts
  • A custom path must have a d.ts extension.

The following global flags work on every command:

• --help boolean
  • Show help.
• --version boolean
  • Show version number.
• --config string (not supported by Pages)
  • Path to .toml configuration file.

---

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 wrangler.toml.

wrangler telemetry status

Was this helpful?

What did you like?

Accurate

Easy to understand

Solved my problem

Helped me decide to use the product

Other

What went wrong?

Hard to understand

Incorrect information

Missing the information

Other

Thank you for helping improve Cloudflare's documentation!