Skip to main content

KV

Manage Workers KV using Wrangler.

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.

Caution

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

kv namespace create

Create a new namespace

npmyarnpnpm

npx wrangler kv namespace create <NAMESPACE>

  • <NAMESPACE> string required

    The name of the new namespace

  • --preview boolean

    Interact with a preview namespace

  • --jurisdiction string

    The jurisdiction where the new namespace will be created (e.g. "us", "eu", "fedramp")

  • --use-remote boolean

    Use a remote binding when adding the newly created resource to your config

  • --update-config boolean

    Automatically update your config file with the newly added resource

  • --binding string

    The binding name of this resource in your Worker

Global flags

To restrict where a namespace durably stores data, specify --jurisdiction when creating it. Refer to Data location for supported jurisdictions.

KV Instant namespaces

Note

Workers KV Instant is currently in private beta. To enroll, contact your Cloudflare account team or sign up and tell us about your use case.

To create a Workers KV Instant namespace, pass --experimental-mode instant. This example creates a namespace named APP_CONFIG for small, infrequently updated configuration:

npmyarnpnpm

npx wrangler@latest kv namespace create APP_CONFIG --experimental-mode instant

You can also use the --x-mode instant alias.

kv namespace list

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

npmyarnpnpm

npx wrangler kv namespace list

Global flags

kv namespace delete

Delete a given namespace.

npmyarnpnpm

npx wrangler kv namespace delete [NAMESPACE]

  • [NAMESPACE] string

    The name of the namespace to 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

  • --skip-confirmation boolean alias: --y default: false

    Skip confirmation

Global flags

kv namespace rename

Rename a KV namespace

npmyarnpnpm

npx wrangler kv namespace rename [OLD-NAME]

  • [OLD-NAME] string

    The current name of the namespace to rename

  • --namespace-id string

    The id of the namespace to rename

  • --new-name string required

    The new name for the namespace

Global flags

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.

Caution

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

kv key put

Write a single key/value pair to the given namespace

npmyarnpnpm

npx wrangler kv key put <KEY> [VALUE]

  • <KEY> string required

    The key to write to

  • [VALUE] string

    The value to write

  • --path string

    Read value from the file at a given path

  • --binding string

    The binding name to the namespace to write to

  • --namespace-id string

    The id of the namespace to write to

  • --preview boolean

    Interact with a preview namespace

  • --ttl number

    Time for which the entries should be visible

  • --expiration number

    Time since the UNIX epoch after which the entry expires

  • --metadata string

    Arbitrary JSON that is associated with a key

  • --local boolean

    Interact with local storage

  • --remote boolean

    Interact with remote storage

  • --persist-to string

    Directory for local persistence

Global flags

kv key list

Output a list of all keys in a given namespace

npmyarnpnpm

npx wrangler kv key list

  • --binding string

    The binding name to the namespace to list

  • --namespace-id string

    The id of the namespace to list

  • --preview boolean default: false

    Interact with a preview namespace

  • --prefix string

    A prefix to filter listed keys

  • --local boolean

    Interact with local storage

  • --remote boolean

    Interact with remote storage

  • --persist-to string

    Directory for local persistence

Global flags

kv key get

Read a single value by key from the given namespace

npmyarnpnpm

npx wrangler kv key get <KEY>

  • <KEY> string required

    The key value to get.

  • --text boolean default: false

    Decode the returned value as a utf8 string

  • --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

  • --local boolean

    Interact with local storage

  • --remote boolean

    Interact with remote storage

  • --persist-to string

    Directory for local persistence

Global flags

kv key delete

Remove a single key value pair from the given namespace

npmyarnpnpm

npx wrangler kv key delete <KEY>

  • <KEY> string required

    The key value to delete.

  • --binding string

    The binding name to the namespace to delete from

  • --namespace-id string

    The id of the namespace to delete from

  • --preview boolean

    Interact with a preview namespace

  • --local boolean

    Interact with local storage

  • --remote boolean

    Interact with remote storage

  • --persist-to string

    Directory for local persistence

Global flags

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.

Caution

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

kv bulk get

Gets multiple key-value pairs from a namespace

npmyarnpnpm

npx 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 default: false

    Interact with a preview namespace

  • --local boolean

    Interact with local storage

  • --remote boolean

    Interact with remote storage

  • --persist-to string

    Directory for local persistence

Global flags

kv bulk put

Upload multiple key-value pairs to a namespace

npmyarnpnpm

npx wrangler kv bulk put <FILENAME>

  • <FILENAME> string required

    The file containing the key/value pairs to write

  • --binding string

    The binding name to the namespace to write to

  • --namespace-id string

    The id of the namespace to write to

  • --preview boolean

    Interact with a preview namespace

  • --ttl number

    Time for which the entries should be visible

  • --expiration number

    Time since the UNIX epoch after which the entry expires

  • --metadata string

    Arbitrary JSON that is associated with a key

  • --local boolean

    Interact with local storage

  • --remote boolean

    Interact with remote storage

  • --persist-to string

    Directory for local persistence

Global flags

kv bulk delete

Delete multiple key-value pairs from a namespace

npmyarnpnpm

npx wrangler kv bulk delete <FILENAME>

  • <FILENAME> string required

    The file containing the keys to delete

  • --force boolean alias: --f

    Do not ask for confirmation before deleting

  • --binding string

    The binding name to the namespace to delete from

  • --namespace-id string

    The id of the namespace to delete from

  • --preview boolean

    Interact with a preview namespace

  • --local boolean

    Interact with local storage

  • --remote boolean

    Interact with remote storage

  • --persist-to string

    Directory for local persistence

Global flags

Edit on GitHub