gcloud alpha emulators firestore start - start a local Firestore emulator
gcloud alpha emulators firestore start [--host-port=HOST_PORT] [--rules=RULES] [GCLOUD_WIDE_FLAG ...]
(ALPHA) This command starts a local Firestore emulator.
To start the local Firestore emulator, run:
$ gcloud alpha emulators firestore start
To bind to a specific host and port, run:
$ gcloud alpha emulators firestore start --host-port=0.0.0.0:8080
To run the local Firestore emulator with a Firebase Rules set, run:
$ gcloud alpha emulators firestore start --rules=firestore.rules
- --host-port=HOST_PORT
The host:port to which the emulator should be bound. Can take the form of a single address (hostname, IPv4, or IPv6) and/or port:
[ADDRESS][:PORT]
In this format you must enclose IPv6 addresses in square brackets: e.g.
[2001:db8:0:0:0:ff00:42:8329]:8080
The default value is localhost:8080.
- --rules=RULES
If set, all projects will use the security rules in this file. More information on Firebase Rules and the syntax for this file is available at https://firebase.google.com/docs/rules.
These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, --help, --impersonate-service-account, --log-http, --project, --quiet, --trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early access allowlist. These variants are also available:
$ gcloud emulators firestore start
$ gcloud beta emulators firestore start