TheFirebase CLI(GitHub) provides avariety of tools for managing, viewing, and deploying to Firebase projects.

Before using theFirebase CLI,set up a Firebase project.

Set up or update the CLI

Install theFirebase CLI

You can install theFirebase CLI using a method that matches your operatingsystem, experience level, and/or use case. Regardless of how you install theCLI, you have access to the same functionality and thefirebase command.

WindowsmacOSLinux

Windows

You can install theFirebase CLI for Windows using one of the followingoptions:

macOS or Linux

You can install theFirebase CLI for macOS or Linux using one of thefollowing options:

Log in and test theFirebase CLI

After installing the CLI, you must authenticate. Then you can confirmauthentication by listing your Firebase projects.

1. Log into Firebase using your Google account by running the followingcommand:

   firebase login

   This command connects your local machine to Firebase and grants youaccess to your Firebase projects.

   Note: Thefirebase login command opens a web page that connects tolocalhost on your machine. If you're using a remote machine and don't haveaccess tolocalhost, run the command with the flag--no-localhost.Note: You can alsouse theFirebase CLI with CI systems.

2. Test that the CLI is properly installed and accessing your account bylisting your Firebase projects. Run the following command:

   firebase projects:list

   The displayed list should be the same as the Firebase projects listed intheFirebase console.

Update to the latest CLI version

Generally, you want to use the most up-to-dateFirebase CLI version.

Uninstall theFirebase CLI

How you uninstall the CLI depends on your operating system and how youinstalled the CLI.

Use the CLI with CI systems

We recommend that you authenticate using Application Default Credentials whenusing the CLI with CI systems.

(Recommended) Use Application Default Credentials

TheFirebase CLI will detect and use Application Default Credentials ifthey're set. The simplest way to authenticate the CLI in CI and otherheadless environments is toset up Application Default Credentials.

(Legacy) UseFIREBASE_TOKEN

Alternatively, you can authenticate usingFIREBASE_TOKEN. This is less securethan Application Default Credentials and is no longer recommended.

1. On a machine with a browser,install theFirebase CLI.

2. Start the signin process by running the following command:

   firebase login:ci

3. Visit the URL provided, then log in using a Google account.

4. Print a newrefresh token.The current CLI session will not be affected.

5. Store the output token in a secure but accessible way in your CI system.

6. Use this token when runningfirebase commands. You can use either of thefollowing two options:

   • Option 1: Store the token as the environment variableFIREBASE_TOKEN. Your system will automatically use the token.

   • Option 2: Run allfirebase commands with the--tokenTOKEN flag in your CI system.
     This is the order of precedence for token loading: flag, environmentvariable, desired Firebase project.

Many common tasks performed using the CLI, such as deploying to a Firebaseproject, require aproject directory. You establish a project directoryusing thefirebase init command. A project directory is usually the samedirectory as your source control root, and after runningfirebase init, thedirectory contains afirebase.json configurationfile.

To initialize a new Firebase project, run the following command from within yourapp's directory:

firebase init

• Select a default Firebase project.

  This step associates the current project directory with a Firebase project sothat project-specific commands (likefirebase deploy) run against theappropriate Firebase project.

  It's also possible toassociate multiple Firebase projects(such as a staging project and a production project) with the same projectdirectory.

• Select desired Firebase products to set up in your Firebase project.

  This step prompts you to set configurations for specific files for theselected products. For more details on these configurations, refer to thespecific product's documentation (for example,Hosting). Note that youcan always runfirebase init later to set up more Firebase products.

At the end of initialization, Firebase automatically creates the following twofiles at the root of your local app directory:

• Afirebase.json configuration file that listsyour project configuration.

• A.firebaserc file that stores your projectaliases.

Thefirebase.json file

Thefirebase init command creates afirebase.json configuration file in the root of your project directory.

Thefirebase.json file is required todeploy assets with theFirebase CLI because it specifieswhich files and settings from your project directory are deployed to yourFirebase project. Since some settings can be defined in either your projectdirectory or theFirebase console, make sure that you resolve any potentialdeployment conflicts.

You canconfigure mostFirebase Hosting optionsdirectly in thefirebase.json file. However, for otherFirebase services that can be deployed with theFirebase CLI,thefirebase init command creates specific files where you can define settingsfor those services, such as anindex.js file forCloud Functions. You canalso set uppredeploy or postdeploy hooks in thefirebase.json file.

{  "hosting": {    "public": "public",    "ignore": [      "firebase.json",      "**/.*",      "**/node_modules/**"    ]  },  "firestore": {      "rules": "firestore.rules",      "indexes": "firestore.indexes.json"  },  "functions": {    "predeploy": [      "npm --prefix \"$RESOURCE_DIR\" run lint",      "npm --prefix \"$RESOURCE_DIR\" run build"    ]  }}

      "firestore": [        {          "database": "(default)",          "rules": "firestore.default.rules",          "indexes": "firestore.default.indexes.json"        },        {          "database": "ecommerce",          "rules": "firestore.ecommerce.rules",          "indexes": "firestore.ecommerce.indexes.json"        }      ],

"ignore": [  ".git",  ".runtimeconfig.json",  "firebase-debug.log",  "firebase-debug.*.log",  "node_modules"]

When you select a Firebase project duringprojectinitialization, the project is automaticallyassigned the alias ofdefault. However, to allow project-specific commands torun against a different Firebase project but still use thesame projectdirectory, run the following command from within your project directory:

firebase use --add

This command prompts you to select another Firebase project and assign theproject as alias. Alias assignments are written to a.firebaserc file insideyour project directory.

Use project aliases

To use assigned Firebase project aliases, run any of the following commands fromwithin your project directory.

You can override what's being used as the currently active project by passingthe--project flag with any CLI command. As an example: You can set yourCLI to run against a Firebase project that you've assigned thestagingalias. If you want to run a single command against the Firebase project thatyou've assigned theprod alias, then you can run, for example,firebase deploy --project=prod.

Source control and project aliases

In general, you should check your.firebaserc file into source control toallow your team to share project aliases. However, for open source projects orstarter templates, you should generally not check in your.firebaserc file.

If you have a development project that's for your use only, you can either passthe--project flag with each command or runfirebase usePROJECT_ID without assigning an alias tothe Firebase project.

Serve and test your Firebase project locally

You can view and test your Firebase project on locally hosted URLs beforedeploying to production. If you only want to test select features, you can usea comma-separated list in a flag on thefirebase serve command.

Run the following command from the root of your local project directory if youwant to do either of the following tasks:

• View the static content for your Firebase-hosted app.
• UseCloud Functions togenerate dynamic content forFirebase Hosting and you want to use yourproduction (deployed) HTTP functions to emulateHosting on a local URL.

firebase serve --only hosting

Emulate your project usinglocal HTTP functions

Run any of the following commands from your project directory to emulate yourproject usinglocal HTTP functions.

• To emulate HTTP functions and hosting for testing on local URLs, use eitherof the following commands:

  firebase serve

  firebase serve --only functions,hosting // uses a flag

• To emulate HTTP functions only, use the following command:

  firebase serve --only functions

Test from other local devices

By default,firebase serve only responds to requests fromlocalhost. Thismeans that you'll be able to access your hosted content from your computer's webbrowser but not from other devices on your network. If you'd like to test fromother local devices, use the--host flag, like so:

firebase serve --host 0.0.0.0  // accepts requests to any host

Deploy to a Firebase project

TheFirebase CLI manages deployment of code and assets to your Firebaseproject, including:

• New releases of yourFirebase Hosting sites
• New, updated, or existingCloud Functions for Firebase
• New or updated schemas and connectors forFirebase Data Connect
• Rules forFirebase Realtime Database
• Rules forCloud Storage for Firebase
• Rules forCloud Firestore
• Indexes forCloud Firestore

To deploy to a Firebase project, run the following command from your projectdirectory:

firebase deploy

You can optionally add a comment to each of your deployments. This comment willdisplay with the other deployment information on your project'sFirebase Hostingpage. For example:

firebase deploy -m "Deploying the best new feature ever."

When you use thefirebase deploy command, be aware of the following:

• To deploy resources from a project directory, the project directorymust have afirebase.json file. This file isautomatically created for you by thefirebase init command.

• By default,firebase deploy creates a release forall deployable resourcesin your project directory. To deploy specific Firebase services or features,use partial deployment.

Deployment conflicts for security rules

ForFirebase Realtime Database,Cloud Storage for Firebase, andCloud Firestore,you can define security rules either in your local project directory or in theFirebase console.

Another option to avoid deployment conflicts is touse partial deployment and only define rules in theFirebase console.

Deployment quotas

It's possible (though unlikely) that you might exceed a quota that limits therate or volume of your Firebase deployment operations. For example, whendeploying very large numbers of functions, you might receive anHTTP 429 Quotaerror message. To solve such issues, tryusing partial deployment.

Roll back a deployment

You can roll back aFirebase Hosting deployment from your project'sFirebase Hostingpage by selectingtheRollback action for the desired release.

It's not currently possible to roll back releases of security rules forFirebase Realtime Database,Cloud Storage for Firebase, orCloud Firestore.

Deploy specific Firebase services

If you only want to deploy specific Firebase services or features, you can use acomma-separated list in a flag on thefirebase deploy command. For example,the following command deploysFirebase Hosting content andCloud Storage security rules.

firebase deploy --only hosting,storage

The following table lists the services and features available for partialdeployment. The names in the flags correspond to the keys in yourfirebase.json configuration file.

firebase deploy --only functions:function1

firebase deploy --only functions:function1,functions:function2

varfunctions=require('firebase-functions/v1');exports.groupA={function1:functions.https.onRequest(...),function2:functions.database.ref('\path').onWrite(...)}exports.groupB=require('./groupB');

varfunctions=require('firebase-functions/v1');exports.function3=functions.storage.object().onChange(...);exports.function4=functions.analytics.event('in_app_purchase').onLog(...);

firebase deploy --only functions:groupA

firebase deploy --only functions:groupA.function1,groupB.function4

To set up predeploy or postdeploy hooks, add bash scripts to yourfirebase.json configuration file. You can definebrief scripts directly in thefirebase.json file, or you can reference otherfiles that are in your project directory.

For example, the following script is thefirebase.json expression for apostdeploy task that sends a Slack message upon successful deployment toFirebase Hosting.

"hosting": {  // ...  "postdeploy": "./messageSlack.sh 'Just deployed toFirebase Hosting'",  "public": "public"}

ThemessageSlack.sh script file resides in the project directory and lookslike this:

curl -X POST -H 'Content-type: application/json' --data '{"text":"$1"}'     \https://SLACK_WEBHOOK_URL

You can set uppredeploy andpostdeploy hooks for any of theassets that you can deploy. Note that runningfirebase deploytriggersall the predeploy and postdeploy tasks defined in yourfirebase.json file. To run only those tasks associated with a specificFirebase service,use partial deployment commands.

Bothpredeploy andpostdeploy hooks print the standard output and errorstreams of the scripts to the terminal. For failure cases, note the following:

• If a predeploy hook fails to complete as expected, deployment is canceled.
• If deployment fails for any reason, postdeploy hooks are not triggered.

Environment variables

Within scripts running in the predeploy and postdeploy hooks, the followingenvironment variables are available:

• $GCLOUD_PROJECT: The active project's project ID
• $PROJECT_DIR: The root directory containing thefirebase.json file
• $RESOURCE_DIR:(Forhosting andfunctions scripts only) Thelocation of the directory that contains theHosting orCloud Functions resources to be deployed

Manage multipleRealtime Database instances

A Firebase project can havemultipleFirebase Realtime Database instances. Bydefault, CLI commands interact with yourdefault database instance.

However, you can interact with a non-default database instance by using the--instanceDATABASE_NAME flag. Thefollowing commands support the--instance flag:

• firebase database:get
• firebase database:profile
• firebase database:push
• firebase database:remove
• firebase database:set
• firebase database:update

Command reference

CLI administrative commands

Project management commands

Deployment and local development

These commands let you deploy and interact with yourFirebase Hosting site.

App Distribution commands

App Hosting commands

Authentication (user management) commands

Cloud Firestore commands

Cloud Functions for Firebase commands

For more information, refer to theenvironmentconfiguration documentation.

Crashlytics commands

Data Connect commands

These commands and their use cases are covered in more detail in theData Connect CLI reference guide.

Extensions commands

Extensions publisher commands

Hosting commands

Realtime Database commands

Note that you can create your initial, defaultRealtime Database instance in theFirebase console or by using thegeneralfirebase initworkflow or the specificfirebase init database flow.

Once instances are created, you can manage them as discussed inManage multipleRealtime Database instances.

Remote Config commands