Справочник по интерфейсу командной строки Firebase

Интерфейс командной строки Firebase ( GitHub ) предоставляет множество инструментов для управления, просмотра и развертывания проектов Firebase.

Перед использованием Firebase CLI необходимо настроить проект Firebase .

Настройте или обновите интерфейс командной строки.

Установите Firebase CLI.

Вы можете установить Firebase CLI, используя способ, соответствующий вашей операционной системе, уровню опыта и/или сценарию использования. Независимо от способа установки CLI, вы получите доступ к тем же функциям и команде firebase .

Windows macOS Linux

Windows

Установить Firebase CLI для Windows можно одним из следующих способов:

macOS или Linux

Установить Firebase CLI для macOS или Linux можно одним из следующих способов:

Войдите в систему и протестируйте Firebase CLI.

После установки CLI необходимо пройти аутентификацию. Затем вы можете подтвердить аутентификацию, перечислив свои проекты Firebase.

1. Войдите в Firebase, используя свою учетную запись Google, выполнив следующую команду:

   firebase login

   Эта команда подключает ваш локальный компьютер к Firebase и предоставляет вам доступ к вашим проектам Firebase.

2. Проверьте правильность установки CLI и его доступ к вашей учетной записи, выведя список ваших проектов Firebase. Выполните следующую команду:

   firebase projects:list

   Отображаемый список должен совпадать со списком проектов Firebase, отображаемым в консоли Firebase .

Обновите CLI до последней версии.

Как правило, рекомендуется использовать самую актуальную версию Firebase CLI.

Способ обновления версии CLI зависит от вашей операционной системы и способа установки CLI.

Удалите Firebase CLI.

Способ удаления CLI зависит от вашей операционной системы и способа установки CLI.

Используйте интерфейс командной строки с системами непрерывной интеграции.

Мы рекомендуем использовать учетные данные приложения по умолчанию при работе с CLI в системах CI для аутентификации.

(Рекомендуется) Использовать учетные данные приложения по умолчанию.

Интерфейс командной строки Firebase обнаружит и будет использовать учетные данные приложения по умолчанию, если они заданы. Самый простой способ аутентификации CLI в CI и других средах без графического интерфейса — это настройка учетных данных приложения по умолчанию .

(Устаревшая версия) Используйте FIREBASE_TOKEN

В качестве альтернативы можно использовать аутентификацию с помощью FIREBASE_TOKEN . Этот способ менее безопасен, чем использование учетных данных приложения по умолчанию, и больше не рекомендуется.

1. На компьютере с установленным браузером установите Firebase CLI .

2. Чтобы начать процесс входа в систему, выполните следующую команду:

   firebase login:ci

3. Перейдите по указанной ссылке, затем войдите в систему, используя учетную запись Google.

4. Вывести новый токен обновления . Текущая сессия CLI останется без изменений.

5. Сохраните выходной токен безопасным, но доступным способом в вашей системе CI.

6. Используйте этот токен при выполнении команд firebase . Вы можете использовать один из следующих двух вариантов:

   • Вариант 1: Сохраните токен в качестве переменной среды FIREBASE_TOKEN . Ваша система автоматически будет использовать этот токен.

   • Вариант 2: Запускайте все команды firebase с флагом --token TOKEN в вашей системе CI.
     Порядок приоритета загрузки токенов следующий: флаг, переменная окружения, желаемый проект Firebase.

Инициализация проекта Firebase

Многие распространенные задачи, выполняемые с помощью CLI, например, развертывание в проекте Firebase, требуют наличия каталога проекта . Каталог проекта создается с помощью команды firebase init . Обычно каталог проекта совпадает с корневым каталогом вашей системы контроля версий, и после выполнения firebase init в этом каталоге находится конфигурационный файл firebase.json .

Для инициализации нового проекта Firebase выполните следующую команду из каталога вашего приложения:

firebase init

    {
      "$schema": "https://raw.githubusercontent.com/firebase/firebase-tools/master/schema/firebase-config.json",
      "hosting": {
        "public": "public",
        "ignore": [
          "firebase.json",
          "**/.*",
          "**/node_modules/**"
        ],
        "cleanUrls": true,
        "trailingSlash": false
      },
      "apphosting": {
        "backendId": "my-app",
        "rootDir": "backend",
        "ignore": [
          "firebase.json",
          "**/.*",
          "**/node_modules/**"
        ]
      },
      "firestore": {
        "rules": "firestore.rules",
        "indexes": "firestore.indexes.json"
      },
      "storage": {
        "rules": "storage.rules"
      },
      "database": {
        "rules": "database.rules.json"
      },
      "dataconnect": {
        "source": "dataconnect",
        "location": "us-central1"
      },
      "functions": [
        {
          "source": "functions",
          "codebase": "default",
          "ignore": [
            "**/.*",
            "**/node_modules/**"
          ],
          "predeploy": [
            "npm --prefix \"$RESOURCE_DIR\" run lint",
            "npm --prefix \"$RESOURCE_DIR\" run build"
          ]
        }
      ],
      "emulators": {
        "auth": {
          "port": 9099
        },
        "functions": {
          "port": 5001
        },
        "firestore": {
          "port": 8080
        },
        "hosting": {
          "port": 5000
        },
        "storage": {
          "port": 9199
        },
        "ui": {
          "enabled": true,
          "port": 4000
        },
        "singleProjectMode": true
      },
      "extensions": {
        "my-storage-resizer": "firebase/storage-resize-images@^0.1.0"
      },
      "auth": {
        "providers": {
          "anonymous": true,
          "emailPassword": true,
          "googleSignIn": {
            "oAuthBrandDisplayName": "My App",
            "supportEmail": "support@myapp.com"
          }
        }
      },
      "remoteconfig": {
        "template": "remoteconfig.template.json"
      }
    }

      "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"
]

firebase use --add

Вы можете переопределить используемый в качестве активного проекта, передав флаг --project в любой команде CLI. Например: вы можете настроить CLI для работы с проектом Firebase, которому вы присвоили псевдоним staging . Если вы хотите выполнить одну команду для проекта Firebase, которому вы присвоили псевдоним prod , то вы можете выполнить, например, firebase deploy --project=prod .

Системы контроля версий и псевдонимы проектов

Как правило, файл .firebaserc следует добавлять в систему контроля версий, чтобы ваша команда могла совместно использовать псевдонимы проекта. Однако для проектов с открытым исходным кодом или стартовых шаблонов обычно не следует добавлять файл .firebaserc в систему контроля версий.

Если у вас есть проект для разработки, предназначенный только для вашего личного использования, вы можете либо передавать флаг --project с каждой командой, либо запустить firebase use PROJECT_ID не назначая псевдоним проекту Firebase.

Развертывайте и тестируйте свой проект Firebase локально.

Вы можете просмотреть и протестировать свой проект Firebase на локально размещенных URL-адресах перед развертыванием в продакшене. Если вы хотите протестировать только отдельные функции, вы можете использовать список, разделенный запятыми, в качестве флага в команде firebase serve .

Для выполнения одной из следующих задач выполните следующую команду из корневого каталога вашего локального проекта:

• Просмотрите статическое содержимое вашего приложения, размещенного на Firebase.
• Вы используете Cloud Functions для генерации динамического контента для Firebase Hosting и хотите использовать свои развернутые в рабочей среде HTTP-функции для эмуляции Hosting на локальном URL-адресе.

firebase serve --only hosting

Эмулируйте свой проект, используя локальные HTTP-функции.

Выполните любую из следующих команд из каталога вашего проекта, чтобы эмулировать ваш проект с использованием локальных HTTP-функций.

• Для эмуляции HTTP-функций и хостинга для тестирования на локальных URL-адресах используйте одну из следующих команд:

  firebase serve

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

• Для эмуляции только HTTP-функций используйте следующую команду:

  firebase serve --only functions

Тестирование с других локальных устройств.

По умолчанию firebase serve отвечает только на запросы с localhost . Это означает, что вы сможете получить доступ к размещенному контенту с веб-браузера вашего компьютера, но не с других устройств в вашей сети. Если вы хотите протестировать с других локальных устройств, используйте флаг --host , например, так:

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

Развернуть в проекте Firebase

Интерфейс командной строки Firebase управляет развертыванием кода и ресурсов в вашем проекте Firebase, включая:

• Новые версии ваших сайтов Firebase Hosting
• Новые, обновленные или существующие Cloud Functions for Firebase
• Новые или обновленные схемы и коннекторы для Firebase SQL Connect
• Security Rules для Firebase Realtime Database
• Security Rules для Cloud Storage for Firebase
• Security Rules для Cloud Firestore
• Индексы для Cloud Firestore
• Настройка Authentication

Для развертывания в проекте Firebase выполните следующую команду из каталога вашего проекта:

firebase deploy

При желании вы можете добавить комментарий к каждому из ваших развертываний. Этот комментарий будет отображаться вместе с остальной информацией о развертывании на странице Firebase Hosting вашего проекта. Например:

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

При использовании команды firebase deploy следует учитывать следующее:

• Для развертывания ресурсов из каталога проекта необходимо наличие файла firebase.json в этом каталоге. Этот файл автоматически создается командой firebase init .

• По умолчанию firebase deploy создает релиз для всех развертываемых ресурсов в каталоге вашего проекта. Для развертывания определенных сервисов или функций Firebase используйте частичное развертывание .

Развертывание отдельных служб Firebase

Если вам нужно развернуть только определенные сервисы или функции Firebase, вы можете использовать список, разделенный запятыми, в качестве флага в команде firebase deploy . Например, следующая команда развертывает контент Firebase Hosting и Cloud Storage Security Rules .

firebase deploy --only hosting,storage

В таблице ниже перечислены сервисы и функции, доступные для частичного развертывания. Названия флагов соответствуют ключам в вашем конфигурационном файле firebase.json .

Конфликты развертывания Security Rules

Для Firebase Realtime Database , Cloud Storage for Firebase и Cloud Firestore Security Rules можно определить либо в локальном каталоге проекта, либо в консоли Firebase .

Ещё один способ избежать конфликтов при развертывании — использовать частичное развертывание и определять Security Rules только в консоли Firebase .

Настройте скриптовые задачи до и после развертывания.

Вы можете подключить скрипты оболочки к команде firebase deploy для выполнения задач до или после развертывания. Например, скрипт до развертывания может транспилировать код TypeScript в JavaScript, а хук после развертывания может уведомлять администраторов о развертывании нового контента сайта в Firebase Hosting .

Для настройки хуков predeploy или postdeploy добавьте bash-скрипты в конфигурационный файл firebase.json . Вы можете определить короткие скрипты непосредственно в файле firebase.json или сослаться на другие файлы, находящиеся в каталоге вашего проекта.

Например, следующий скрипт представляет собой выражение в firebase.json для задачи postdeploy, которая отправляет сообщение в Slack после успешного развертывания на Firebase Hosting .

"hosting": {
  // ...

  "postdeploy": "./messageSlack.sh 'Just deployed to Firebase Hosting'",
  "public": "public"
}

Файл скрипта messageSlack.sh находится в каталоге проекта и выглядит следующим образом:

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

Вы можете настроить хуки predeploy и postdeploy для любого из развертываемых ресурсов . Обратите внимание, что запуск firebase deploy запускает все задачи predeploy и postdeploy, определенные в файле firebase.json . Чтобы запустить только те задачи, которые связаны с конкретной службой Firebase, используйте команды частичного развертывания .

Как хуки predeploy так и postdeploy выводят в терминал стандартный поток вывода и потоки ошибок скриптов. В случае сбоя обратите внимание на следующее:

• Если проверка перед развертыванием не завершится должным образом, развертывание будет отменено.
• Если развертывание по какой-либо причине не удается, обработчики событий postdeploy не срабатывают.

переменные окружающей среды

В скриптах, запускаемых в рамках обработчиков predeploy и postdeploy, доступны следующие переменные среды:

• $GCLOUD_PROJECT : Идентификатор проекта активного проекта
• $PROJECT_DIR : Корневой каталог, содержащий файл firebase.json
• $RESOURCE_DIR : (Только для скриптов hosting и functions ) Расположение каталога, содержащего ресурсы Hosting или Cloud Functions которые необходимо развернуть.

Квоты на развертывание

Вполне возможно (хотя и маловероятно), что вы превысите квоту, ограничивающую скорость или объем операций развертывания Firebase. Например, при развертывании очень большого количества функций вы можете получить сообщение об ошибке HTTP 429 Quota . Для решения таких проблем попробуйте использовать частичное развертывание .

Откат развертывания

Вы можете откатить развертывание Firebase Hosting со страницы Firebase Hosting вашего проекта, выбрав действие «Откат» для выбранного релиза.

Откатить обновления Security Rules for Firebase Realtime Database , Cloud Storage for Firebase или Cloud Firestore невозможно.

Справочник команд

Административные команды CLI

Команды управления проектами

Развертывание и локальное развитие

Эти команды позволяют развертывать ваш сайт Firebase Hosting и взаимодействовать с ним.

Команды App Distribution

Команды App Hosting

Команды Authentication (управления пользователями)

Команды Cloud Firestore

Cloud Functions for Firebase commands

For more information, refer to the environment configuration documentation .

Crashlytics commands

SQL Connect commands

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

Extensions commands

Extensions publisher commands

Hosting commands

Realtime Database commands

Note that you can create your initial, default Realtime Database instance in the Firebase console or by using the general firebase init workflow or the specific firebase init database flow.

Once instances are created, you can manage them as described in Manage and interact with specific instances using the CLI .

Remote Config commands

The Firebase CLI ( GitHub ) provides a variety of tools for managing, viewing, and deploying to Firebase projects.

Before using the Firebase CLI, set up a Firebase project .

Set up or update the CLI

Install the Firebase CLI

You can install the Firebase CLI using a method that matches your operating system, experience level, and/or use case. Regardless of how you install the CLI, you have access to the same functionality and the firebase command.

Windows macOS Linux

Windows

You can install the Firebase CLI for Windows using one of the following options:

macOS or Linux

You can install the Firebase CLI for macOS or Linux using one of the following options:

Log in and test the Firebase CLI

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

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

   firebase login

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

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

   firebase projects:list

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

Update to the latest CLI version

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

How you update the CLI version depends on your operating system and how you installed the CLI.

Uninstall the Firebase CLI

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

Use the CLI with CI systems

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

(Recommended) Use Application Default Credentials

The Firebase CLI will detect and use Application Default Credentials if they're set. The simplest way to authenticate the CLI in CI and other headless environments is to set up Application Default Credentials .

(Legacy) Use FIREBASE_TOKEN

Alternatively, you can authenticate using FIREBASE_TOKEN . This is less secure than Application Default Credentials and is no longer recommended.

1. On a machine with a browser, install the Firebase 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 new refresh 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 running firebase commands. You can use either of the following two options:

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

   • Option 2: Run all firebase commands with the --token TOKEN flag in your CI system.
     This is the order of precedence for token loading: flag, environment variable, desired Firebase project.

Initialize a Firebase project

Many common tasks performed using the CLI, such as deploying to a Firebase project, require a project directory . You establish a project directory using the firebase init command. A project directory is usually the same directory as your source control root, and after running firebase init , the directory contains a firebase.json configuration file.

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

firebase init

    {
      "$schema": "https://raw.githubusercontent.com/firebase/firebase-tools/master/schema/firebase-config.json",
      "hosting": {
        "public": "public",
        "ignore": [
          "firebase.json",
          "**/.*",
          "**/node_modules/**"
        ],
        "cleanUrls": true,
        "trailingSlash": false
      },
      "apphosting": {
        "backendId": "my-app",
        "rootDir": "backend",
        "ignore": [
          "firebase.json",
          "**/.*",
          "**/node_modules/**"
        ]
      },
      "firestore": {
        "rules": "firestore.rules",
        "indexes": "firestore.indexes.json"
      },
      "storage": {
        "rules": "storage.rules"
      },
      "database": {
        "rules": "database.rules.json"
      },
      "dataconnect": {
        "source": "dataconnect",
        "location": "us-central1"
      },
      "functions": [
        {
          "source": "functions",
          "codebase": "default",
          "ignore": [
            "**/.*",
            "**/node_modules/**"
          ],
          "predeploy": [
            "npm --prefix \"$RESOURCE_DIR\" run lint",
            "npm --prefix \"$RESOURCE_DIR\" run build"
          ]
        }
      ],
      "emulators": {
        "auth": {
          "port": 9099
        },
        "functions": {
          "port": 5001
        },
        "firestore": {
          "port": 8080
        },
        "hosting": {
          "port": 5000
        },
        "storage": {
          "port": 9199
        },
        "ui": {
          "enabled": true,
          "port": 4000
        },
        "singleProjectMode": true
      },
      "extensions": {
        "my-storage-resizer": "firebase/storage-resize-images@^0.1.0"
      },
      "auth": {
        "providers": {
          "anonymous": true,
          "emailPassword": true,
          "googleSignIn": {
            "oAuthBrandDisplayName": "My App",
            "supportEmail": "support@myapp.com"
          }
        }
      },
      "remoteconfig": {
        "template": "remoteconfig.template.json"
      }
    }

      "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"
]

firebase use --add

You can override what's being used as the active project by passing the --project flag with any CLI command. As an example: You can set your CLI to run against a Firebase project that you've assigned the staging alias. If you want to run a single command against the Firebase project that you've assigned the prod 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 to allow your team to share project aliases. However, for open source projects or starter 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 pass the --project flag with each command or run firebase use PROJECT_ID without assigning an alias to the Firebase project.

Serve and test your Firebase project locally

You can view and test your Firebase project on locally hosted URLs before deploying to production. If you only want to test select features, you can use a comma-separated list in a flag on the firebase serve command.

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

• View the static content for your Firebase-hosted app.
• Use Cloud Functions to generate dynamic content for Firebase Hosting and you want to use your production (deployed) HTTP functions to emulate Hosting on a local URL.

firebase serve --only hosting

Emulate your project using local HTTP functions

Run any of the following commands from your project directory to emulate your project using local HTTP functions.

• To emulate HTTP functions and hosting for testing on local URLs, use either of 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 from localhost . This means that you'll be able to access your hosted content from your computer's web browser but not from other devices on your network. If you'd like to test from other 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

The Firebase CLI manages deployment of code and assets to your Firebase project, including:

• New releases of your Firebase Hosting sites
• New, updated, or existing Cloud Functions for Firebase
• New or updated schemas and connectors for Firebase SQL Connect
• Security Rules for Firebase Realtime Database
• Security Rules for Cloud Storage for Firebase
• Security Rules for Cloud Firestore
• Indexes for Cloud Firestore
• Configuration for Authentication

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

firebase deploy

You can optionally add a comment to each of your deployments. This comment will display with the other deployment information on your project's Firebase Hosting page . For example:

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

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

• To deploy resources from a project directory, the project directory must have a firebase.json file. This file is automatically created for you by the firebase init command.

• By default, firebase deploy creates a release for all deployable resources in your project directory. To deploy specific Firebase services or features, use partial deployment .

Deploy specific Firebase services

If you only want to deploy specific Firebase services or features, you can use a comma-separated list in a flag on the firebase deploy command. For example, the following command deploys Firebase Hosting content and Cloud Storage Security Rules .

firebase deploy --only hosting,storage

The following table lists the services and features available for partial deployment. The names in the flags correspond to the keys in your firebase.json configuration file.

Deployment conflicts for Security Rules

For Firebase Realtime Database , Cloud Storage for Firebase , and Cloud Firestore , you can define Security Rules either in your local project directory or in the Firebase console .

Another option to avoid deployment conflicts is to use partial deployment and only define Security Rules in the Firebase console.

Set up predeploy and postdeploy scripted tasks

You can connect shell scripts to the firebase deploy command to perform predeploy or postdeploy tasks. For example, a predeploy script could transpile TypeScript code into JavaScript, and a postdeploy hook could notify administrators of new site content deploys to Firebase Hosting .

To set up predeploy or postdeploy hooks, add bash scripts to your firebase.json configuration file. You can define brief scripts directly in the firebase.json file, or you can reference other files that are in your project directory.

For example, the following script is the firebase.json expression for a postdeploy task that sends a Slack message upon successful deployment to Firebase Hosting .

"hosting": {
  // ...

  "postdeploy": "./messageSlack.sh 'Just deployed to Firebase Hosting'",
  "public": "public"
}

The messageSlack.sh script file resides in the project directory and looks like this:

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

You can set up predeploy and postdeploy hooks for any of the assets that you can deploy . Note that running firebase deploy triggers all the predeploy and postdeploy tasks defined in your firebase.json file. To run only those tasks associated with a specific Firebase service, use partial deployment commands .

Both predeploy and postdeploy hooks print the standard output and error streams 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.

переменные окружающей среды

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

• $GCLOUD_PROJECT : The active project's project ID
• $PROJECT_DIR : The root directory containing the firebase.json file
• $RESOURCE_DIR : (For hosting and functions scripts only) The location of the directory that contains the Hosting or Cloud Functions resources to be deployed

Deployment quotas

It's possible (though unlikely) that you might exceed a quota that limits the rate or volume of your Firebase deployment operations. For example, when deploying very large numbers of functions, you might receive an HTTP 429 Quota error message. To solve such issues, try using partial deployment .

Roll back a deployment

You can roll back a Firebase Hosting deployment from your project's Firebase Hosting page by selecting the Rollback action for the chosen release.

It's not possible to roll back releases of Security Rules for Firebase Realtime Database , Cloud Storage for Firebase , or Cloud Firestore .

Справочник команд

CLI administrative commands

Project management commands

Deployment and local development

These commands let you deploy and interact with your Firebase 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 the environment configuration documentation .

Crashlytics commands

SQL Connect commands

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

Extensions commands

Extensions publisher commands

Hosting commands

Realtime Database commands

Note that you can create your initial, default Realtime Database instance in the Firebase console or by using the general firebase init workflow or the specific firebase init database flow.

Once instances are created, you can manage them as described in Manage and interact with specific instances using the CLI .

Remote Config commands

The Firebase CLI ( GitHub ) provides a variety of tools for managing, viewing, and deploying to Firebase projects.

Before using the Firebase CLI, set up a Firebase project .

Set up or update the CLI

Install the Firebase CLI

You can install the Firebase CLI using a method that matches your operating system, experience level, and/or use case. Regardless of how you install the CLI, you have access to the same functionality and the firebase command.

Windows macOS Linux

Windows

You can install the Firebase CLI for Windows using one of the following options:

macOS or Linux

You can install the Firebase CLI for macOS or Linux using one of the following options:

Log in and test the Firebase CLI

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

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

   firebase login

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

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

   firebase projects:list

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

Update to the latest CLI version

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

How you update the CLI version depends on your operating system and how you installed the CLI.

Uninstall the Firebase CLI

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

Use the CLI with CI systems

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

(Recommended) Use Application Default Credentials

The Firebase CLI will detect and use Application Default Credentials if they're set. The simplest way to authenticate the CLI in CI and other headless environments is to set up Application Default Credentials .

(Legacy) Use FIREBASE_TOKEN

Alternatively, you can authenticate using FIREBASE_TOKEN . This is less secure than Application Default Credentials and is no longer recommended.

1. On a machine with a browser, install the Firebase 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 new refresh 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 running firebase commands. You can use either of the following two options:

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

   • Option 2: Run all firebase commands with the --token TOKEN flag in your CI system.
     This is the order of precedence for token loading: flag, environment variable, desired Firebase project.

Initialize a Firebase project

Many common tasks performed using the CLI, such as deploying to a Firebase project, require a project directory . You establish a project directory using the firebase init command. A project directory is usually the same directory as your source control root, and after running firebase init , the directory contains a firebase.json configuration file.

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

firebase init

    {
      "$schema": "https://raw.githubusercontent.com/firebase/firebase-tools/master/schema/firebase-config.json",
      "hosting": {
        "public": "public",
        "ignore": [
          "firebase.json",
          "**/.*",
          "**/node_modules/**"
        ],
        "cleanUrls": true,
        "trailingSlash": false
      },
      "apphosting": {
        "backendId": "my-app",
        "rootDir": "backend",
        "ignore": [
          "firebase.json",
          "**/.*",
          "**/node_modules/**"
        ]
      },
      "firestore": {
        "rules": "firestore.rules",
        "indexes": "firestore.indexes.json"
      },
      "storage": {
        "rules": "storage.rules"
      },
      "database": {
        "rules": "database.rules.json"
      },
      "dataconnect": {
        "source": "dataconnect",
        "location": "us-central1"
      },
      "functions": [
        {
          "source": "functions",
          "codebase": "default",
          "ignore": [
            "**/.*",
            "**/node_modules/**"
          ],
          "predeploy": [
            "npm --prefix \"$RESOURCE_DIR\" run lint",
            "npm --prefix \"$RESOURCE_DIR\" run build"
          ]
        }
      ],
      "emulators": {
        "auth": {
          "port": 9099
        },
        "functions": {
          "port": 5001
        },
        "firestore": {
          "port": 8080
        },
        "hosting": {
          "port": 5000
        },
        "storage": {
          "port": 9199
        },
        "ui": {
          "enabled": true,
          "port": 4000
        },
        "singleProjectMode": true
      },
      "extensions": {
        "my-storage-resizer": "firebase/storage-resize-images@^0.1.0"
      },
      "auth": {
        "providers": {
          "anonymous": true,
          "emailPassword": true,
          "googleSignIn": {
            "oAuthBrandDisplayName": "My App",
            "supportEmail": "support@myapp.com"
          }
        }
      },
      "remoteconfig": {
        "template": "remoteconfig.template.json"
      }
    }

      "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"
]

firebase use --add

You can override what's being used as the active project by passing the --project flag with any CLI command. As an example: You can set your CLI to run against a Firebase project that you've assigned the staging alias. If you want to run a single command against the Firebase project that you've assigned the prod 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 to allow your team to share project aliases. However, for open source projects or starter 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 pass the --project flag with each command or run firebase use PROJECT_ID without assigning an alias to the Firebase project.

Serve and test your Firebase project locally

You can view and test your Firebase project on locally hosted URLs before deploying to production. If you only want to test select features, you can use a comma-separated list in a flag on the firebase serve command.

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

• View the static content for your Firebase-hosted app.
• Use Cloud Functions to generate dynamic content for Firebase Hosting and you want to use your production (deployed) HTTP functions to emulate Hosting on a local URL.

firebase serve --only hosting

Emulate your project using local HTTP functions

Run any of the following commands from your project directory to emulate your project using local HTTP functions.

• To emulate HTTP functions and hosting for testing on local URLs, use either of 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 from localhost . This means that you'll be able to access your hosted content from your computer's web browser but not from other devices on your network. If you'd like to test from other 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

The Firebase CLI manages deployment of code and assets to your Firebase project, including:

• New releases of your Firebase Hosting sites
• New, updated, or existing Cloud Functions for Firebase
• New or updated schemas and connectors for Firebase SQL Connect
• Security Rules for Firebase Realtime Database
• Security Rules for Cloud Storage for Firebase
• Security Rules for Cloud Firestore
• Indexes for Cloud Firestore
• Configuration for Authentication

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

firebase deploy

You can optionally add a comment to each of your deployments. This comment will display with the other deployment information on your project's Firebase Hosting page . For example:

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

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

• To deploy resources from a project directory, the project directory must have a firebase.json file. This file is automatically created for you by the firebase init command.

• By default, firebase deploy creates a release for all deployable resources in your project directory. To deploy specific Firebase services or features, use partial deployment .

Deploy specific Firebase services

If you only want to deploy specific Firebase services or features, you can use a comma-separated list in a flag on the firebase deploy command. For example, the following command deploys Firebase Hosting content and Cloud Storage Security Rules .

firebase deploy --only hosting,storage

The following table lists the services and features available for partial deployment. The names in the flags correspond to the keys in your firebase.json configuration file.

Deployment conflicts for Security Rules

For Firebase Realtime Database , Cloud Storage for Firebase , and Cloud Firestore , you can define Security Rules either in your local project directory or in the Firebase console .

Another option to avoid deployment conflicts is to use partial deployment and only define Security Rules in the Firebase console.

Set up predeploy and postdeploy scripted tasks

You can connect shell scripts to the firebase deploy command to perform predeploy or postdeploy tasks. For example, a predeploy script could transpile TypeScript code into JavaScript, and a postdeploy hook could notify administrators of new site content deploys to Firebase Hosting .

To set up predeploy or postdeploy hooks, add bash scripts to your firebase.json configuration file. You can define brief scripts directly in the firebase.json file, or you can reference other files that are in your project directory.

For example, the following script is the firebase.json expression for a postdeploy task that sends a Slack message upon successful deployment to Firebase Hosting .

"hosting": {
  // ...

  "postdeploy": "./messageSlack.sh 'Just deployed to Firebase Hosting'",
  "public": "public"
}

The messageSlack.sh script file resides in the project directory and looks like this:

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

You can set up predeploy and postdeploy hooks for any of the assets that you can deploy . Note that running firebase deploy triggers all the predeploy and postdeploy tasks defined in your firebase.json file. To run only those tasks associated with a specific Firebase service, use partial deployment commands .

Both predeploy and postdeploy hooks print the standard output and error streams 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.

переменные окружающей среды

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

• $GCLOUD_PROJECT : The active project's project ID
• $PROJECT_DIR : The root directory containing the firebase.json file
• $RESOURCE_DIR : (For hosting and functions scripts only) The location of the directory that contains the Hosting or Cloud Functions resources to be deployed

Deployment quotas

It's possible (though unlikely) that you might exceed a quota that limits the rate or volume of your Firebase deployment operations. For example, when deploying very large numbers of functions, you might receive an HTTP 429 Quota error message. To solve such issues, try using partial deployment .

Roll back a deployment

You can roll back a Firebase Hosting deployment from your project's Firebase Hosting page by selecting the Rollback action for the chosen release.

It's not possible to roll back releases of Security Rules for Firebase Realtime Database , Cloud Storage for Firebase , or Cloud Firestore .

Справочник команд

CLI administrative commands

Project management commands

Deployment and local development

These commands let you deploy and interact with your Firebase 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 the environment configuration documentation .

Crashlytics commands

SQL Connect commands

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

Extensions commands

Extensions publisher commands

Hosting commands

Realtime Database commands

Note that you can create your initial, default Realtime Database instance in the Firebase console or by using the general firebase init workflow or the specific firebase init database flow.

Once instances are created, you can manage them as described in Manage and interact with specific instances using the CLI .

Remote Config commands

The Firebase CLI ( GitHub ) provides a variety of tools for managing, viewing, and deploying to Firebase projects.

Before using the Firebase CLI, set up a Firebase project .

Set up or update the CLI

Install the Firebase CLI

You can install the Firebase CLI using a method that matches your operating system, experience level, and/or use case. Regardless of how you install the CLI, you have access to the same functionality and the firebase command.

Windows macOS Linux

Windows

You can install the Firebase CLI for Windows using one of the following options:

macOS or Linux

You can install the Firebase CLI for macOS or Linux using one of the following options:

Log in and test the Firebase CLI

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

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

   firebase login

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

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

   firebase projects:list

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

Update to the latest CLI version

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

How you update the CLI version depends on your operating system and how you installed the CLI.

Uninstall the Firebase CLI

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

Use the CLI with CI systems

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

(Recommended) Use Application Default Credentials

The Firebase CLI will detect and use Application Default Credentials if they're set. The simplest way to authenticate the CLI in CI and other headless environments is to set up Application Default Credentials .

(Legacy) Use FIREBASE_TOKEN

Alternatively, you can authenticate using FIREBASE_TOKEN . This is less secure than Application Default Credentials and is no longer recommended.

1. On a machine with a browser, install the Firebase 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 new refresh 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 running firebase commands. You can use either of the following two options:

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

   • Option 2: Run all firebase commands with the --token TOKEN flag in your CI system.
     This is the order of precedence for token loading: flag, environment variable, desired Firebase project.

Initialize a Firebase project

Many common tasks performed using the CLI, such as deploying to a Firebase project, require a project directory . You establish a project directory using the firebase init command. A project directory is usually the same directory as your source control root, and after running firebase init , the directory contains a firebase.json configuration file.

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

firebase init

    {
      "$schema": "https://raw.githubusercontent.com/firebase/firebase-tools/master/schema/firebase-config.json",
      "hosting": {
        "public": "public",
        "ignore": [
          "firebase.json",
          "**/.*",
          "**/node_modules/**"
        ],
        "cleanUrls": true,
        "trailingSlash": false
      },
      "apphosting": {
        "backendId": "my-app",
        "rootDir": "backend",
        "ignore": [
          "firebase.json",
          "**/.*",
          "**/node_modules/**"
        ]
      },
      "firestore": {
        "rules": "firestore.rules",
        "indexes": "firestore.indexes.json"
      },
      "storage": {
        "rules": "storage.rules"
      },
      "database": {
        "rules": "database.rules.json"
      },
      "dataconnect": {
        "source": "dataconnect",
        "location": "us-central1"
      },
      "functions": [
        {
          "source": "functions",
          "codebase": "default",
          "ignore": [
            "**/.*",
            "**/node_modules/**"
          ],
          "predeploy": [
            "npm --prefix \"$RESOURCE_DIR\" run lint",
            "npm --prefix \"$RESOURCE_DIR\" run build"
          ]
        }
      ],
      "emulators": {
        "auth": {
          "port": 9099
        },
        "functions": {
          "port": 5001
        },
        "firestore": {
          "port": 8080
        },
        "hosting": {
          "port": 5000
        },
        "storage": {
          "port": 9199
        },
        "ui": {
          "enabled": true,
          "port": 4000
        },
        "singleProjectMode": true
      },
      "extensions": {
        "my-storage-resizer": "firebase/storage-resize-images@^0.1.0"
      },
      "auth": {
        "providers": {
          "anonymous": true,
          "emailPassword": true,
          "googleSignIn": {
            "oAuthBrandDisplayName": "My App",
            "supportEmail": "support@myapp.com"
          }
        }
      },
      "remoteconfig": {
        "template": "remoteconfig.template.json"
      }
    }

      "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"
]

firebase use --add

You can override what's being used as the active project by passing the --project flag with any CLI command. As an example: You can set your CLI to run against a Firebase project that you've assigned the staging alias. If you want to run a single command against the Firebase project that you've assigned the prod 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 to allow your team to share project aliases. However, for open source projects or starter 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 pass the --project flag with each command or run firebase use PROJECT_ID without assigning an alias to the Firebase project.

Serve and test your Firebase project locally

You can view and test your Firebase project on locally hosted URLs before deploying to production. If you only want to test select features, you can use a comma-separated list in a flag on the firebase serve command.

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

• View the static content for your Firebase-hosted app.
• Use Cloud Functions to generate dynamic content for Firebase Hosting and you want to use your production (deployed) HTTP functions to emulate Hosting on a local URL.

firebase serve --only hosting

Emulate your project using local HTTP functions

Run any of the following commands from your project directory to emulate your project using local HTTP functions.

• To emulate HTTP functions and hosting for testing on local URLs, use either of 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 from localhost . This means that you'll be able to access your hosted content from your computer's web browser but not from other devices on your network. If you'd like to test from other 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

The Firebase CLI manages deployment of code and assets to your Firebase project, including:

• New releases of your Firebase Hosting sites
• New, updated, or existing Cloud Functions for Firebase
• New or updated schemas and connectors for Firebase SQL Connect
• Security Rules for Firebase Realtime Database
• Security Rules for Cloud Storage for Firebase
• Security Rules for Cloud Firestore
• Indexes for Cloud Firestore
• Configuration for Authentication

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

firebase deploy

You can optionally add a comment to each of your deployments. This comment will display with the other deployment information on your project's Firebase Hosting page . For example:

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

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

• To deploy resources from a project directory, the project directory must have a firebase.json file. This file is automatically created for you by the firebase init command.

• By default, firebase deploy creates a release for all deployable resources in your project directory. To deploy specific Firebase services or features, use partial deployment .

Deploy specific Firebase services

If you only want to deploy specific Firebase services or features, you can use a comma-separated list in a flag on the firebase deploy command. For example, the following command deploys Firebase Hosting content and Cloud Storage Security Rules .

firebase deploy --only hosting,storage

The following table lists the services and features available for partial deployment. The names in the flags correspond to the keys in your firebase.json configuration file.

Deployment conflicts for Security Rules

For Firebase Realtime Database , Cloud Storage for Firebase , and Cloud Firestore , you can define Security Rules either in your local project directory or in the Firebase console .

Another option to avoid deployment conflicts is to use partial deployment and only define Security Rules in the Firebase console.

Set up predeploy and postdeploy scripted tasks

You can connect shell scripts to the firebase deploy command to perform predeploy or postdeploy tasks. For example, a predeploy script could transpile TypeScript code into JavaScript, and a postdeploy hook could notify administrators of new site content deploys to Firebase Hosting .

To set up predeploy or postdeploy hooks, add bash scripts to your firebase.json configuration file. You can define brief scripts directly in the firebase.json file, or you can reference other files that are in your project directory.

For example, the following script is the firebase.json expression for a postdeploy task that sends a Slack message upon successful deployment to Firebase Hosting .

"hosting": {
  // ...

  "postdeploy": "./messageSlack.sh 'Just deployed to Firebase Hosting'",
  "public": "public"
}

The messageSlack.sh script file resides in the project directory and looks like this:

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

You can set up predeploy and postdeploy hooks for any of the assets that you can deploy . Note that running firebase deploy triggers all the predeploy and postdeploy tasks defined in your firebase.json file. To run only those tasks associated with a specific Firebase service, use partial deployment commands .

Both predeploy and postdeploy hooks print the standard output and error streams 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.

переменные окружающей среды

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

• $GCLOUD_PROJECT : The active project's project ID
• $PROJECT_DIR : The root directory containing the firebase.json file
• $RESOURCE_DIR : (For hosting and functions scripts only) The location of the directory that contains the Hosting or Cloud Functions resources to be deployed

Deployment quotas

It's possible (though unlikely) that you might exceed a quota that limits the rate or volume of your Firebase deployment operations. For example, when deploying very large numbers of functions, you might receive an HTTP 429 Quota error message. To solve such issues, try using partial deployment .

Roll back a deployment

You can roll back a Firebase Hosting deployment from your project's Firebase Hosting page by selecting the Rollback action for the chosen release.

It's not possible to roll back releases of Security Rules for Firebase Realtime Database , Cloud Storage for Firebase , or Cloud Firestore .

Справочник команд

CLI administrative commands

Project management commands

Deployment and local development

These commands let you deploy and interact with your Firebase Hosting site.

App Distribution commands

App Hosting commands

Authentication (user management) commands

Cloud Firestore commands