Go to console

Install a Firebase Extension

You can install (and manage) any of the official Firebase extensions using either the Firebase console or the Firebase CLI (command-line interface).

Make sure to review the differences in the supported actions for the Firebase CLI and Firebase console.


To install or manage extensions, you need to be a project Owner.

Before you begin

  1. If you haven't already, add Firebase to your project.

  2. Install or update to the latest version of the Firebase CLI.

  3. Take note of either your Firebase project ID or previously configured project alias.

    • Project ID — Run firebase list from anywhere on your computer.
    • Project alias — Run firebase use from your local app directory.

Step 1: View detailed information about an extension

This step is optional, but strongly recommended.

Before installing a Firebase Extension, we recommend that you review detailed information about the extension, including:

  • General identifying information and description
  • Description of user-configurable parameters
  • Resources created (including any functions)
  • Whether the extension's tasks require a billing account
  • How the extension works, any pre-installation tasks, and details about the extension
  • Google services (APIs) used
  • Access roles required for operation

To view an extension's detailed information:

  1. Make sure that you've set up your environment and selected an extension.

  2. Run the extension-info command from anywhere on your computer:

    firebase ext:info extension-name

    Where extension-name is required and can be found either in the extension's detail page or in the name field of the extension's extension.yaml file.

Step 2: Install an extension

During the installation process, you'll be prompted to review the basic specifications for the Firebase Extension (such as APIs enabled, resources created, access granted, etc.). You'll be notified of any billing requirements, and you'll also be prompted to provide values for the extension's configurable parameters.

  1. Make sure that you've set up your environment and selected an extension.

  2. Run the extension-install command:

    firebase ext:install extension-name --project=projectId-or-alias --params=path/to/envFile
    • extension-name is required and can be found either in the extension's detail page or in the name field of the extension's extension.yaml file.

    • --params is an optional flag to supply a file that defines the values of user-configurable parameters and allows you to bypass the interactive terminal prompts for these values. Define your values in a .env file that follows the dotenv syntax.

    For example, to supply a .env file when installing awesome-task-simplifier run:

    firebase ext:install awesome-task-simplifier --project=my-project-id --params=./parameters/myAwesomeValues.env
  3. If you're prompted (or you didn't supply a .env file), enter parameter values to customize the extension for your project.

  4. Review the extension's post-installation information displayed in the terminal.
    This information describes specific usage instructions and any further integration requirements.

    You can check out the post-installation information anytime — visit the installed extension's detail page in the Extensions dashboard of the Firebase console or view the POSTINSTALL.md file included in the extension's source directory.

  5. (Optional) To test out your extension right away, you can follow the See it in action steps displayed in the terminal.

Next Steps

  • View the details and the configuration of your installed extension in the Firebase console.

  • Monitor the activity of your installed extension, including checks on its health, usage, and logs.

  • Using the Firebase CLI, manage your installed extension. You can reconfigure or uninstall your extension, as well as update your extension to the latest version.

  • Using the Firebase console, manage your installed extension. For official Firebase extensions, you can reconfigure or uninstall your extension, as well as update your extension to the latest version.

  • As a best practice for all projects, make sure to set up billing alerts for your project.