Skip to content
Back to search

firenook

A faster drop-in replacement for the Firebase Local Emulator Suite: keep your firebase.json, SDKs and ports, and get 40× faster writes, 10× less memory, no Java, and data that survives restarts.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/firenook-dev/firenook with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/firenook-dev/firenook'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/firenook-dev--firenook/badge.svg)](/listings/firenook-dev--firenook)

HTML

<a href="/listings/firenook-dev--firenook"><img src="/api/listings/firenook-dev--firenook/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 297 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. <p align="center">
  2. <picture>
  3. <source media="(prefers-color-scheme: dark)" srcset="brand/logo/firenook-logo-on-dark.svg">
  4. <img alt="Firenook" src="brand/logo/firenook-logo.svg" height="72">
  5. </picture>
  6. </p>
  7. <h3 align="center">A faster drop-in replacement for the Firebase Local Emulator Suite</h3>
  8. <p align="center">
  9. Keep your <code>firebase.json</code>, SDKs and ports. Get 40× faster writes,
  10. 10× less memory, no Java, and data that survives restarts.
  11. </p>
  12. <p align="center">
  13. <a href="https://www.npmjs.com/package/firenook"><img alt="npm" src="https://img.shields.io/npm/v/firenook?label=npm&color=1c53cf"></a>
  14. <a href="LICENSE"><img alt="License: Apache-2.0" src="https://img.shields.io/badge/license-Apache--2.0-1c53cf"></a>
  15. <img alt="macOS, Linux and Windows" src="https://img.shields.io/badge/platforms-macOS%20%C2%B7%20Linux%20%C2%B7%20Windows-555">
  16. </p>
  17. <p align="center">
  18. <a href="docs/getting-started.md">Getting started</a> ·
  19. <a href="docs/README.md">Docs</a> ·
  20. <a href="docs/benchmarks.md">Benchmarks</a> ·
  21. <a href="COMPATIBILITY.md">Compatibility</a> ·
  22. <a href="https://github.com/firenook-dev/firenook/releases">Releases</a>
  23. </p>
  24. <p align="center">
  25. <img alt="npx firebase emulators:start becomes npx firenook emulators:start --keep-data: the start-up card picks up 1.2 million kept documents, then the ready summary and a live log of function calls, including a failed webhook with its stack trace" src="docs/assets/terminal.gif" width="760">
  26. </p>
  27. **Already using the Firebase emulators?** Install Firenook and change one word:
  28. ```sh
  29. npm install --save-dev firenook
  30. ```
  31. ```diff
  32. - firebase emulators:start --import ./data
  33. + firenook emulators:start --import ./data
  34. ```
  35. Same flags, same ports, and your `firebase.json`, rules, Functions code and app
  36. stay as they are. In a terminal, run it as `npx firenook emulators:start`. To
  37. keep your data between runs, with no export at every stop, add `--keep-data`.
  38. Firenook needs Node 22, 24 or 26, on macOS, Linux or Windows. Starting a new project?
  39. `npx firenook init` sets one up. [Get started](#get-started) covers both.
  40. ## Why Firenook
  41. **A drop-in for the official emulator.** Firenook reads `firebase.json`,
  42. `.firebaserc`, rules and indexes the way the Firebase CLI does, serves
  43. Firestore, Auth, Storage, Functions, Pub/Sub, Cloud Tasks and Eventarc on the
  44. same ports, and your client and Admin SDKs connect unchanged. It imports and
  45. exports the official format, so your data moves both ways. Every change is
  46. checked against recorded behaviour of the official emulator.
  47. **Fast and light.** The services are native Rust and the data lives on disk,
  48. not in a Java heap. On a real application's two-hour workload, Firenook
  49. peaked at 2.11 GiB of memory where the official emulator reached 22.57 GiB,
  50. answered writes in 5.1 ms against 208 ms at the median, and used 61% less CPU.
  51. **Your data stays.** Add `--keep-data` and Firestore, Auth and Storage come
  52. back with all your data in about half a second, even with millions of
  53. documents: no export at every stop, no import at every start. A
  54. crash loses at most the last second of writes, where the official emulator
  55. loses everything since its last export, and a stop always closes the data
  56. cleanly.
  57. **One package, nothing else to install.** No Java, no firebase-tools, nothing
  58. else downloaded at install or start: one npm package with a native engine for
  59. macOS, Linux and Windows. Node runs your Functions, as in production. (An
  60. Extension from the registry is fetched once, on first use;
  61. `firenook ext:vendor` makes even that offline.)
  62. **A console and a terminal made for it.** A web console for every service,
  63. live as your app runs, and a terminal screen that shows each function call,
  64. what triggered it, how long it took, and the stack trace when it fails.
  65. **Ready for your agent.** `firenook mcp` gives a coding agent the running
  66. suite: read and write Firestore, manage users and sign in as them, read the
  67. logs and each function call with its error, ask the Security Rules why a
  68. request is denied, and work with Storage files, Pub/Sub, Cloud Tasks and
  69. Eventarc. `npx firenook mcp add` sets it up for Claude Code, Cursor and VS Code
  70. in the project's own files; [other agents](docs/mcp.md#connect-your-agent) run
  71. the same `npx firenook mcp`. Nothing leaves your machine.
  72. ## What it emulates
  73. | Service | Port | Highlights |
  74. | --- | ---: | --- |
  75. | Firestore | 8080 | Native and web SDKs, realtime listeners, Security Rules, named databases, official import and export, a warning and a console Indexes page that adds the entry to `firestore.indexes.json` (or with `--strict-indexes` a refusal) for a query whose index the file does not declare |
  76. | Authentication | 9099 | Every operation of the official Auth emulator: password, email link, phone, anonymous, custom tokens, test sign-in with Google, Apple and other providers, MFA, passkeys, tenants, blocking functions |
  77. | Cloud Storage | 9199 | Firebase and Cloud Storage APIs, Security Rules evaluated natively, including `firestore.get()` and `exists()` |
  78. | Cloud Functions | 5001 | HTTP, callable and streaming functions; Firestore, Storage, Auth, Pub/Sub, Eventarc, schedule and task-queue triggers; reload on save; `--inspect-functions`; `functions:invoke` for any trigger |
  79. | Extensions | 5001 | Local, vendored or registry sources, offline once vendored |
  80. | Pub/Sub | 8085 | Every RPC over gRPC and HTTP/JSON: push, ordering, filters, dead-letter topics, seek, snapshots, Avro schemas |
  81. | Cloud Tasks | 9499 | Queues for `onTaskDispatched` with the official retry and rate-limit behaviour |
  82. | Eventarc | 9299 | Custom events delivered to `onCustomEventPublished` |
  83. The console is on 4000, the hub on 4400 and logging on 4500. These are the
  84. official suite's ports, and `firebase.json` changes them the same way.
  85. Realtime Database, Hosting, App Hosting and Data Connect are not emulated; a
  86. `firebase.json` that configures them still starts, with a warning.
  87. [COMPATIBILITY.md](COMPATIBILITY.md) records what each service covers and what
  88. it does not.
  89. ## The console
  90. **The console the Firebase emulators should have had.** Google's Emulator UI
  91. has no page for your Functions, Pub/Sub, Cloud Tasks or Eventarc, only a log.
  92. Firenook's console covers every service it runs, live, on the Emulator UI's
  93. port, at <http://127.0.0.1:4000/console>:
  94. - **Functions:** every call with what triggered it, its outcome, its duration
  95. and its logs, and every schedule. The official UI has only the log.
  96. - **Authentication:** users, their activity, and an inbox of the sign-in codes
  97. and email links Auth would have sent, so you never dig through the terminal
  98. for them.
  99. - **Firestore and Storage:** browse, edit and upload, and read their
  100. security rules.
  101. - **Pub/Sub, Cloud Tasks and Eventarc,** which the official UI has no pages
  102. for.
  103. - **An Overview** of every service's health and recent problems, with
  104. snapshots and resets a click away.
  105. Light and dark, works offline, sends nothing anywhere. Bookmarks to the
  106. official UI's pages open the matching console page.
  107. <picture>
  108. <source media="(prefers-color-scheme: dark)" srcset="docs/assets/console-overview-dark.png">
  109. <img alt="The console's Overview: the health of all nine services with their counts and ports, and recent problems" src="docs/assets/console-overview-light.png">
  110. </picture>
  111. | Function invocations | Authentication |
  112. | --- | --- |
  113. | <picture><source media="(prefers-color-scheme: dark)" srcset="docs/assets/console-invocations-dark.png"><img alt="Every function call with its trigger, outcome and duration" src="docs/assets/console-invocations-light.png"></picture> | <picture><source media="(prefers-color-scheme: dark)" srcset="docs/assets/console-auth-dark.png"><img alt="Authentication: users with filters, one open with its profile, security and providers" src="docs/assets/console-auth-light.png"></picture> |
  114. | **Firestore** | **Storage** |
  115. | <picture><source media="(prefers-color-scheme: dark)" srcset="docs/assets/console-firestore-dark.png"><img alt="Firestore: collections, a page of orders and one open for editing" src="docs/assets/console-firestore-light.png"></picture> | <picture><source media="(prefers-color-scheme: dark)" srcset="docs/assets/console-storage-dark.png"><img alt="Storage: a folder of product photos as a grid of thumbnails" src="docs/assets/console-storage-light.png"></picture> |
  116. More in [the console guide](docs/console.md).
  117. ## Benchmarks
  118. One server (a Ryzen 5 3600 with 64 GiB), one real application with 211,205
  119. Firestore documents and 6.7 GB in Storage, and two hours of its traffic against
  120. each emulator in turn. Then each emulator alone on the same data: starts,
  121. stops, 26 query shapes and a store grown to 2.5 million documents.
  122. <picture>
  123. <source media="(prefers-color-scheme: dark)" srcset="docs/assets/benchmark-dark.svg">
  124. <img alt="Firenook against the official emulator: 10 times less memory, writes 40 times faster, listener updates 19 times faster, restarts 52 times sooner, orderBy with a limit 8 times faster, 61% less CPU" src="docs/assets/benchmark-light.svg" width="880">
  125. </picture>
  126. Firenook answered 25 of the 26 query shapes faster and tied on the last, and
  127. both gave the same answers. The method, every figure and the limits are in
  128. [the benchmarks](docs/benchmarks.md).
  129. ## Get started
  130. ### Already using the Firebase emulator
  131. **1. Install it** in the project, next to firebase-tools (keep that for
  132. deploying):
  133. ```sh
  134. npm install --save-dev firenook # or: bun add --dev firenook
  135. ```
  136. Commit the lockfile: it keeps every machine and CI run on the release you
  137. installed, and the same engine, until you upgrade.
  138. Every run keeps its working data under `.firenook/`, so add that folder to
  139. your `.gitignore`.
  140. **2. Check your project.** This reads `firebase.json` the way the Firebase CLI
  141. does and changes nothing:
  142. ```console
  143. $ npx firenook init --adopt --dry-run
  144. skip Firenook: firebase.json configures the hosting emulator, which Firenook does not implement; skipping it.
  145. ok nothing to change; services: firestore, auth, storage, functions
  146. ```
  147. It names any service Firenook skips (Realtime Database, Hosting, App Hosting,
  148. Data Connect) and any addition it would make, such as a missing `emulators`
  149. entry; `npx firenook init --adopt` applies those additions.
  150. **3. Swap the command.** Same flags, same ports, and the same export format, so
  151. your existing data imports as it is:
  152. ```diff
  153. "scripts": {
  154. - "emulators": "firebase emulators:start --import ./data --export-on-exit",
  155. - "test:integration": "firebase emulators:exec \"npm test\""
  156. + "emulators": "firenook emulators:start --import ./data --export-on-exit",
  157. + "test:integration": "firenook emulators:exec \"npm test\""
  158. }
  159. ```
  160. Your app connects to the same ports as before, so no code changes:
  161. `connectFirestoreEmulator(db, '127.0.0.1', 8080)`, `FIRESTORE_EMULATOR_HOST`
  162. and the rest work unchanged.
  163. **4. Optionally, stop exporting at every stop.** In place of
  164. `--export-on-exit`, add `--keep-data` and Firenook keeps your data between runs
  165. in `.firenook/state`. Every start after the first picks the data up where you
  166. left it, and `./data` itself stays untouched:
  167. ```sh
  168. npx firenook emulators:start --import ./data --keep-data
  169. ```
  170. Going back is just as short: stop Firenook (it saves first), export with
  171. `npx firenook emulators:export ./export`, and start the official CLI on that
  172. export.
  173. ### Starting a new project
  174. ```sh
  175. npx firenook init
  176. ```
  177. <p align="center">
  178. <img alt="firenook init: a screen of choices already made, the set-up as it runs, and the emulators started in the same terminal" src="docs/assets/init.gif" width="760">
  179. </p>
  180. In a terminal, `init` opens on one screen with every choice already made:
  181. a `demo-<folder>` project, so nothing can reach a real Firebase project,
  182. every emulator on its usual port (one already in use is named, with what
  183. holds it), Functions in TypeScript, JavaScript or none, and the coding agents
  184. it finds. Enter takes them all. It then writes the official templates,
  185. installs the packages, pins Firenook in `package.json`, builds the
  186. TypeScript once, and starts the emulators in the same terminal. From then on:
  187. ```sh
  188. npm run emulators # firenook emulators:start --keep-data --build
  189. ```
  190. A new project keeps its data between runs from the first start, and
  191. `--build` compiles your TypeScript as you save, with the errors in the log.
  192. In a script or CI, `npx firenook init --yes` does the same with no questions.
  193. Point your app at it:
  194. ```js
  195. connectFirestoreEmulator(db, '127.0.0.1', 8080);
  196. connectAuthEmulator(auth, 'http://127.0.0.1:9099');
  197. connectStorageEmulator(storage, '127.0.0.1', 9199);
  198. connectFunctionsEmulator(functions, '127.0.0.1', 5001);
  199. ```
  200. Firenook needs Node 22, 24 or 26 on macOS, Linux (glibc 2.28 or newer, so
  201. RHEL 8, Debian 10, Ubuntu 20.04, node:24-slim and later; not Alpine) or
  202. Windows x64. The [getting started guide](docs/getting-started.md) covers each
  203. step in more
  204. depth, including tests and keeping data.
  205. ## Documentation
  206. - [Getting started](docs/getting-started.md) · [The terminal](docs/terminal.md)
  207. · [The console](docs/console.md) · [Configuration](docs/configuration.md)
  208. - [Functions and Extensions](docs/functions-and-extensions.md) ·
  209. [Data, state and tests](docs/data-and-state.md) ·
  210. [Model Context Protocol](docs/mcp.md) · [CLI reference](docs/cli.md)
  211. - [Benchmarks](docs/benchmarks.md) · [Compatibility](COMPATIBILITY.md) ·
  212. [Versions and verification](docs/versions-and-verification.md) ·
  213. [Roadmap](ROADMAP.md) · [Design](DESIGN.md)
  214. ## Status
  215. Firenook 0.2.0 is the first stable release. Every release passes conformance
  216. replays against the official emulator and packed installs on all five
  217. platforms, and releases are measured against the official emulator with a
  218. real application (most recently 0.2.0, in the
  219. [benchmarks](docs/benchmarks.md)). Commit your lockfile and upgrade on
  220. purpose; [the releases](https://github.com/firenook-dev/firenook/releases) list
  221. what each one carries.
  222. ## Contributing
  223. Firenook is built in the open under the Apache License 2.0.
  224. [CONTRIBUTING.md](CONTRIBUTING.md) explains how a change moves, from a
  225. recorded fixture of the official emulator to a release, and how to build and
  226. test from source. Report a bug or ask for a feature in the
  227. [issues](https://github.com/firenook-dev/firenook/issues).
  228. ## License and trademarks
  229. Firenook is licensed under the [Apache License 2.0](LICENSE); see
  230. [NOTICE](NOTICE) for the reference-only sources studied and
  231. [TRADEMARKS.md](TRADEMARKS.md) for the use of the Firenook name and mark.
  232. Firebase, Cloud Firestore, Cloud Functions, Cloud Storage, Cloud Pub/Sub and
  233. Cloud Tasks are trademarks of Google LLC. Firenook is not affiliated with or
  234. endorsed by Google.

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.