Wrangler KV commands
The wrangler kv ...
commands allow you to manage your Workers KV resources in the Cloudflare network.
Manage KV namespaces.
Creates a new KV namespace.
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).
- Interact with a preview namespace (the
Lists all KV namespaces associated with the current account ID.
Deletes a given KV namespace.
--binding
string- The binding name of the namespace, as stored in the
wrangler.toml
file, to delete.
- The binding name of the namespace, as stored in the
--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.
Manage key-value pairs within a KV namespace.
Writes a single key-value pair to a particular KV namespace.
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 theVALUE
argument. This is ideal for security-sensitive operations because it avoids saving keys and values into your terminal history.
- When defined, the value is loaded from the file at
--binding
string- The binding name of the KV namespace, as stored in the
wrangler.toml
file, where the key-pair will be stored.
- The binding name of the KV namespace, as stored in the
--namespace-id
string- The ID of the KV namespace where the key-pair will be stored.
--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 theexpiration
option.
- The lifetime (in number of seconds) that the key-value pair should exist before expiring. Must be at least
--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.
Reads a single value by key from the given KV namespace.
KEY
string required- The key value to get.
--binding
string- The binding name of the namespace, as stored in the
wrangler.toml
file, where the key-pair is stored.
- The binding name of the namespace, as stored in the
--namespace-id
string- The ID of the namespace where the key-pair is stored.
--env
string optional- Perform on a specific environment.
--preview
boolean optional- Interact with a preview namespace instead of production.
Outputs a list of all keys in a given KV namespace.
--binding
string- The binding name of the namespace, as stored in the
wrangler.toml
file, from which keys are listed.
- The binding name of the namespace, as stored in the
--namespace-id
string- The ID of the namespace from which keys are listed.
--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.
Removes a single key value pair from the given namespace.
KEY
string required- The key value to get.
--binding
string- The binding name of the namespace, as stored in the
wrangler.toml
file, from where the key is removed.
- The binding name of the namespace, as stored in the
--namespace-id
string- The ID of the namespace from which the key is removed.
--env
string optional- Perform on a specific environment.
--preview
boolean optional- Interact with a preview namespace instead of production.
Manage multiple key-value pairs within a KV namespace in batches.
Writes a JSON file containing an array of key-value pairs to the given namespace.
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, from which key-pairs are bulked.
- The binding name of the namespace, as stored in the
--namespace-id
string- The ID of the namespace from which key-pairs are bulked.
--env
string optional- Perform on a specific environment.
--preview
boolean optional- Interact with a preview namespace instead of production.
This command takes a JSON file as an argument with a list of key-value pairs to upload. An example of JSON input:
KV namespace values can only store strings. In order to save complex a value, stringify it to JSON:
Here is 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 1024 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.
- The number of seconds the document should exist before expiring. Must be at least
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
.
- 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
Deletes all keys read from a JSON file within a given namespace.
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, from which keys are removed.
- The binding name of the namespace, as stored in the
--namespace-id
string- The ID of the namespace from which keys are removed.
--env
string optional- Perform on a specific environment.
--preview
boolean optional- Interact with a preview namespace instead of production.
This command takes a JSON file as an argument containing an array of keys to delete. Here is an example of the JSON input:
Below are deprecations to Wrangler commands for Workers KV.
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:
The same commands using the kv:...
syntax look as such: