Manage and export KV data

List, inspect, and bulk-edit KV entries from the CLI, plus a restorable export format.

KV commands address a namespace by its name. Keys can be up to 512 bytes and values up to 1 MiB.

Individual keys

npx sproutboat kv key list registrations --prefix email:
npx sproutboat kv key get registrations email:person@example.com --text
npx sproutboat kv key put registrations email:person@example.com joined
npx sproutboat kv key delete registrations email:person@example.com --yes

pnpm sproutboat kv key list registrations --prefix email:
pnpm sproutboat kv key get registrations email:person@example.com --text
pnpm sproutboat kv key put registrations email:person@example.com joined
pnpm sproutboat kv key delete registrations email:person@example.com --yes

bunx sproutboat kv key list registrations --prefix email:
bunx sproutboat kv key get registrations email:person@example.com --text
bunx sproutboat kv key put registrations email:person@example.com joined
bunx sproutboat kv key delete registrations email:person@example.com --yes

yarn sproutboat kv key list registrations --prefix email:
yarn sproutboat kv key get registrations email:person@example.com --text
yarn sproutboat kv key put registrations email:person@example.com joined
yarn sproutboat kv key delete registrations email:person@example.com --yes

Export

npx sproutboat kv export registrations \
  --prefix email: \
  --output registrations.json

pnpm sproutboat kv export registrations \
  --prefix email: \
  --output registrations.json

bunx sproutboat kv export registrations \
  --prefix email: \
  --output registrations.json

yarn sproutboat kv export registrations \
  --prefix email: \
  --output registrations.json

The export pages through matching keys, reads values in bounded batches, and writes incrementally to a permission-restricted temporary file.

Exports use the version 1 text-value format accepted by kv bulk put:

[
  { "key": "email:person@example.com", "value": "joined" }
]

Bulk operations

Bulk get and delete take a JSON array of key strings:

["email:first@example.com", "email:second@example.com"]

npx sproutboat kv bulk get registrations keys.json --output values.json
npx sproutboat kv bulk put registrations registrations.json
npx sproutboat kv bulk delete registrations keys.json --yes

pnpm sproutboat kv bulk get registrations keys.json --output values.json
pnpm sproutboat kv bulk put registrations registrations.json
pnpm sproutboat kv bulk delete registrations keys.json --yes

bunx sproutboat kv bulk get registrations keys.json --output values.json
bunx sproutboat kv bulk put registrations registrations.json
bunx sproutboat kv bulk delete registrations keys.json --yes

yarn sproutboat kv bulk get registrations keys.json --output values.json
yarn sproutboat kv bulk put registrations registrations.json
yarn sproutboat kv bulk delete registrations keys.json --yes