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
If you haven't already, add Firebase to your project.
Take note of either your Firebase project ID or previously configured project alias.
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:
Run the extension-info command from anywhere on your computer:
firebase ext:info extension-name
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.
Run the extension-install command:
firebase ext:install extension-name --project=projectId-or-alias --params=path/to/envFile
--paramsis 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
.envfile that follows the dotenv syntax.
For example, to supply a
.envfile when installing
firebase ext:install awesome-task-simplifier --project=my-project-id --params=./parameters/myAwesomeValues.env
If you're prompted (or you didn't supply a
.envfile), enter parameter values to customize the extension for your project.
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.mdfile included in the extension's source directory.
(Optional) To test out your extension right away, you can follow the See it in action steps displayed in the terminal.
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.