​​ Wrangler commands

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

• init - Create a skeleton Wrangler project, including the wrangler.toml file.
• dev - Start a local server for developing your Worker.
• publish - Publish your Worker to 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.
• secret - Manage the secret variables for a Worker.
• tail - Start a session to livestream logs from a deployed Worker.
• login - Authorize Wrangler with your Cloudflare account using OAuth.
• logout - Remove Wrangler’s authorization for accessing your account.

​​ init

Create a skeleton Wrangler project, including the wrangler.toml file.

$ wrangler init [NAME] [-y / --yes]

​​ dev

Start a local server for developing your Worker.

$ wrangler dev [SCRIPT] [OPTIONS]

The wrangler dev command that establishes a connection between localhost and a Cloudflare server that hosts your Worker in development. This allows full access to Workers KV and Durable Objects. wrangler dev is a way to easily test your Worker while developing.

~/my-worker $ wrangler dev
⬣ Listening at http://localhost:8787
╭──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ [b] open a browser, [d] open Devtools, [l] turn on local mode, [c] clear console, [x] to exit                        │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

With wrangler dev running, you can 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.

​​ publish

Publish your Worker to Cloudflare.

$ wrangler publish [SCRIPT] [OPTIONS]

​​ kv:namespace

Manage Workers KV namespaces.

​​ create

Create a new namespace.

$ wrangler kv:namespace create <NAMESPACE> [OPTIONS]

​​ list

List all KV namespaces associated with the current account ID.

$ wrangler kv:namespace list

​​ delete

Delete a given namespace.

$ wrangler kv:namespace delete [OPTIONS]

​​ kv:key

Manage key-value pairs within a Workers KV namespace.

​​ put

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

$ wrangler kv:key put <KEY> [VALUE] [OPTIONS]

​​ list

Output a list of all keys in a given namespace.

$ wrangler kv:key list [OPTIONS]

​​ get

Read a single value by key from the given namespace.

$ wrangler kv:key get <KEY> [OPTIONS]

​​ delete

Remove a single key value pair from the given namespace.

$ wrangler kv:key delete <KEY> [OPTIONS]

​​ kv:bulk

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

​​ put

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

$ wrangler kv:bulk put <FILENAME> [OPTIONS]

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
  }
]

Here is the full schema for key-value entries uploaded via the bulk API:

​​ delete

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

$ wrangler kv:bulk delete <FILENAME> [OPTIONS]

This command takes a JSON file as an argument containing an array of keys to delete. Here is an example of the JSON input:

["test_key_1", "test_key_2"]

​​ secret

Manage the secret variables for a Worker.

​​ put

Create or replace a secret for a Worker.

$ wrangler secret put <NAME> [OPTIONS]

​​ delete

Delete a secret for a Worker.

$ wrangler secret delete <NAME> [OPTIONS]

​​ list

List the names of all the secrets for a Worker.

$ wrangler secret list [OPTIONS]

​​ tail

Start a session to livestream logs from a deployed Worker.

$ wrangler tail <NAME> [OPTIONS]

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

​​ login

Authorize Wrangler with your Cloudflare account using OAuth. This will open a login page in your browser and request your account access permissions.

$ wrangler login [OPTIONS]

​​ logout

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

$ wrangler logout

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 Open external link .
2. Go to Overview > Get your API token in the right-side menu.
3. Select the three-dot menu on your Wrangler token.
4. Select Delete.