跳转到主要内容

Adding local data

import { Details, LinkCard, Render, PackageManagers, FileTree, } from "~/components";

Whether you are using Wrangler or the Cloudflare Vite plugin, your workflow for accessing data during local development remains the same. However, you can only populate local resources with data via the Wrangler CLI.

How it works

When you run either wrangler dev or vite, Miniflare automatically creates local versions of your resources (like KV, D1, or R2). This means you don’t need to manually set up separate local instances for each service. However, newly created local resources won’t contain any data — you'll need to use Wrangler commands with the --local flag to populate them. Changes made to local resources won’t affect production data.

Populating local resources with data

When you first start developing, your local resources will be empty. You'll need to populate them with data using the Wrangler CLI.

KV namespaces

:::caution[Syntax note] 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 in the Wrangler commands for KV page. :::

Add a single key-value pair

Bulk upload

R2 buckets

Upload a file

You may also include other metadata.

D1 databases

Execute a SQL statement

Execute a SQL file

Flagship apps

Copy flags from a remote app

Create a flag in the local store

To manage the local store with the cf CLI instead, refer to Flagship local development.

Durable Objects

For Durable Objects, unlike KV, D1, and R2, there are no CLI commands to populate them with local data. To add data to Durable Objects during local development, you must write application code that creates Durable Object instances and calls methods on them that store state. This typically involves creating development endpoints or test routes that initialize your Durable Objects with the desired data.

Where local data gets stored

By default, both Wrangler and the Vite plugin store local binding data in the same location: the .wrangler/state folder in your project directory. This folder stores data in subdirectories for all local bindings: KV namespaces, R2 buckets, D1 databases, Durable Objects, etc.

Clearing local storage

You can delete the .wrangler/state folder at any time to reset your local environment, and Miniflare will recreate it the next time you run your dev command. You can also delete specific sub-folders within .wrangler/state for more targeted clean-up.

Changing the local data directory

If you prefer to specify a different directory for local storage, you can do so through the Wrangler CLI or in the Vite plugin's configuration.

Using Wrangler

Use the --persist-to flag with wrangler dev. You need to specify this flag every time you run the dev command:

:::note The local persistence folder (like .wrangler/state or any custom folder you set) should be added to your .gitignore to avoid committing local development data to version control. :::

If you run `wrangler dev --persist-to ` to specify a custom location for local data, you must also include the same `--persist-to ` when running other Wrangler commands that modify local data (and be sure to include the `--local` flag).

For example, to create a KV key named test with a value of 12345 in a local KV namespace, run:

This command:

  • Sets the KV key test to 12345 in the binding MY_KV_NAMESPACE (defined in your Wrangler configuration file).
  • Uses --persist-to worker-local to ensure the data is created in the worker-local directory instead of the default .wrangler/state.
  • Adds the --local flag, indicating you want to modify local data.

If --persist-to is not specified, Wrangler defaults to using .wrangler/state for local data.

Using the Cloudflare Vite plugin

To customize where the Vite plugin stores local data, configure the persistState option in your Vite config file:

import { defineConfig } from "vite";
import { cloudflare } from "@cloudflare/vite-plugin";

export default defineConfig({
	plugins: [
		cloudflare({
			persistState: { path: "./my-custom-directory" },
		}),
	],
});

Sharing state between tools

If you want Wrangler and the Vite plugin to share the same state, configure them to use the same persistence path.