Bolt is an experimental security and rules compiler for Firebase Realtime Database (not for Firebase Cloud Storage). It is currently in beta. The language definition is converging, but not yet finalized. We welcome experimentation, but ask that you hand-verify the resulting JSON output before using with production applications.
This repository is no longer under active development. No new features will be added and issues are not actively triaged. Pull Requests which fix bugs are welcome and will be reviewed on a best-effort basis.
If you maintain a fork of this repository that you believe is healthier than the official version, we may consider recommending your fork. Please open a Pull Request if you believe that is the case.
- Guide to Using Firebase Bolt - Introduction to using Bolt.
- Firebase Security and Modeling Language - Language documentation and syntax.
Using the Bolt Compiler
You can easily install the bolt compiler using npm:
$ npm install --global firebase-bolt
Execute the Bolt compiler from the command line:
$ firebase-bolt rules.bolt
$ firebase deploy
The firebase command line tool version 2 will also compile your Bolt file directly if you have firebase-bolt installed and you use the .bolt file extension in the rules property of your firebase.json configuration file.
Developing with this Repo
You should have node.js and npm installed to use this repository.
Setup command line environment and build and test.
$ source tools/use $ configure-project $ gulp
$ gulp lint
Build Bolt parser from PEG grammar:
$ gulp build
Run command line tests:
$ gulp test
More extensive tests which include running against a sandboxed Firebase app:
Run browser-based tests: