Wrangler KV commands

kv namespace

Manage Workers KV namespaces.

Note

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

Warning

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

kv namespace create

npm

npx wrangler kv namespace create [NAMESPACE]

pnpm

pnpm wrangler kv namespace create [NAMESPACE]

yarn

yarn wrangler kv namespace create [NAMESPACE]

• [NAMESPACE] string required

  The name of the new namespace

• --preview boolean

  Interact with a preview namespace

kv namespace list

npm

npx wrangler kv namespace list

pnpm

pnpm wrangler kv namespace list

yarn

yarn wrangler kv namespace list

kv namespace delete

npm

npx wrangler kv namespace delete

pnpm

pnpm wrangler kv namespace delete

yarn

yarn wrangler kv namespace delete

• --binding string

  The binding name to the namespace to delete from

• --namespace-id string

  The id of the namespace to delete

• --preview boolean

  Interact with a preview namespace

kv namespace rename

npm

npx wrangler kv namespace rename [OLD-NAME]

pnpm

pnpm wrangler kv namespace rename [OLD-NAME]

yarn

yarn wrangler kv namespace rename [OLD-NAME]

• [OLD-NAME] string

  The current name (title) of the namespace to rename

• --namespace-id string

  The id of the namespace to rename

• --new-name string required

  The new name for the namespace

kv key

Manage key-value pairs within a Workers KV namespace.

Note

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

Warning

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

kv key put

npm

npx wrangler kv key put [KEY] [VALUE]

pnpm

pnpm wrangler kv key put [KEY] [VALUE]

yarn

yarn wrangler kv key put [KEY] [VALUE]

• [KEY] string required

  The key to write to

• [VALUE] string

  The value to write

• --binding string

  The binding name to the namespace to write to

• --namespace-id string

  The id of the namespace to write to

• --preview boolean

  Interact with a preview namespace

• --ttl number

  Time for which the entries should be visible

• --expiration number

  Time since the UNIX epoch after which the entry expires

• --metadata string

  Arbitrary JSON that is associated with a key

• --path string

  Read value from the file at a given path

• --local boolean

  Interact with local storage

• --remote boolean

  Interact with remote storage

• --persist-to string

  Directory for local persistence

kv key list

npm

npx wrangler kv key list

pnpm

pnpm wrangler kv key list

yarn

yarn wrangler kv key list

• --binding string

  The binding name to the namespace to list

• --namespace-id string

  The id of the namespace to list

• --preview boolean default: false

  Interact with a preview namespace

• --prefix string

  A prefix to filter listed keys

• --local boolean

  Interact with local storage

• --remote boolean

  Interact with remote storage

• --persist-to string

  Directory for local persistence

kv key get

npm

npx wrangler kv key get [KEY]

pnpm

pnpm wrangler kv key get [KEY]

yarn

yarn wrangler kv key get [KEY]

• [KEY] string required

  The key value to get.

• --binding string

  The binding name to the namespace to get from

• --namespace-id string

  The id of the namespace to get from

• --preview boolean default: false

  Interact with a preview namespace

• --text boolean default: false

  Decode the returned value as a utf8 string

• --local boolean

  Interact with local storage

• --remote boolean

  Interact with remote storage

• --persist-to string

  Directory for local persistence

kv key delete

npm

npx wrangler kv key delete [KEY]

pnpm

pnpm wrangler kv key delete [KEY]

yarn

yarn wrangler kv key delete [KEY]

• [KEY] string required

  The key value to delete.

• --binding string

  The binding name to the namespace to delete from

• --namespace-id string

  The id of the namespace to delete from

• --preview boolean

  Interact with a preview namespace

• --local boolean

  Interact with local storage

• --remote boolean

  Interact with remote storage

• --persist-to string

  Directory for local persistence

kv bulk

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

Note

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

Warning

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

kv bulk get

npm

npx wrangler kv bulk get [FILENAME]

pnpm

pnpm wrangler kv bulk get [FILENAME]

yarn

yarn wrangler kv bulk get [FILENAME]

• [FILENAME] string required

  The file containing the keys to get

• --binding string

  The binding name to the namespace to get from

• --namespace-id string

  The id of the namespace to get from

• --preview boolean

  Interact with a preview namespace

• --local boolean

  Interact with local storage

• --remote boolean

  Interact with remote storage

• --persist-to string

  Directory for local persistence

kv bulk put

npm

npx wrangler kv bulk put [FILENAME]

pnpm

pnpm wrangler kv bulk put [FILENAME]

yarn

yarn wrangler kv bulk put [FILENAME]

• [FILENAME] string required

  The file containing the key/value pairs to write

• --binding string

  The binding name to the namespace to write to

• --namespace-id string

  The id of the namespace to write to

• --preview boolean

  Interact with a preview namespace

• --ttl number

  Time for which the entries should be visible

• --expiration number

  Time since the UNIX epoch after which the entry expires

• --metadata string

  Arbitrary JSON that is associated with a key

• --local boolean

  Interact with local storage

• --remote boolean

  Interact with remote storage

• --persist-to string

  Directory for local persistence

kv bulk delete

npm

npx wrangler kv bulk delete [FILENAME]

pnpm

pnpm wrangler kv bulk delete [FILENAME]

yarn

yarn wrangler kv bulk delete [FILENAME]

• [FILENAME] string required

  The file containing the keys to delete

• --binding string

  The binding name to the namespace to delete from

• --namespace-id string

  The id of the namespace to delete from

• --preview boolean

  Interact with a preview namespace

• --force boolean alias: --f

  Do not ask for confirmation before deleting

• --local boolean

  Interact with local storage

• --remote boolean

  Interact with remote storage

• --persist-to string

  Directory for local persistence

Global flags

The following global flags work on every command:

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

Deprecations

Below are deprecations to Wrangler commands for Workers KV.

kv:... syntax deprecation

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.

The kv:... syntax is deprecated in versions 3.60.0 and beyond and will be removed in a future major version.

For example, commands using the kv ... syntax look as such:

wrangler kv namespace list
wrangler kv key get <KEY>
wrangler kv bulk put <FILENAME>

The same commands using the kv:... syntax look as such:

wrangler kv:namespace list
wrangler kv:key get <KEY>
wrangler kv:bulk put <FILENAME>