Skip to content

These docs are for Miniflare 2 which is no longer supported apart from critical security updates.
Please see the migration guide to upgrade to Miniflare 3, and the updated API docs.

Visit Miniflare on GitHub
Set theme to dark (โ‡ง+D)

๐Ÿ”ฅ Miniflare

Miniflare is a simulator for developing and testing Cloudflare Workers. It's written in TypeScript, and runs your code in a sandbox implementing Workers' runtime APIs.

  • ๐ŸŽ‰ Fun: develop workers easily with detailed logging, file watching and pretty error pages supporting source maps.
  • ๐Ÿ”‹ Full-featured: supports most Workers features, including KV, Durable Objects, WebSockets, modules and more.
  • โšก Fully-local: test and develop Workers without an internet connection. Reload code on change quickly.

Get StartedGitHubnpm

These docs primarily cover Miniflare specific things. For more information on runtime APIs, refer to the Cloudflare Workers docs.

If you find something that doesn't behave as it does in the real Workers environment (and this difference isn't documented), or something's wrong in these docs, please open a GitHub issue.

These docs are built with the Cloudflare Docs Engine. Tab icons are from Feather.