Skip to content

CLI

Manifest Generation

Generate one BlurManifest JSON file from a local directory.

Use this flow when your build or app needs a precomputed placeholder map.

Terminal window
npx blurkit encode ./public \
--glob "**/*.{jpg,jpeg,png,webp}" \
--out blur-manifest.json \
--pretty
  • --glob selects files inside the input directory.
  • --concurrency controls parallel file encoding.
  • --backend selects sharp (default) or wasm.
  • Key mapping behavior:
    • files under /public map to URL-style keys such as /images/hero.jpg
    • other folders map to normalized relative keys
    • --base-path prepends a custom key prefix
  • --glob cannot be used with remote URL input.
  • Manifest key conventions must match your app lookup strategy.