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

Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.

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

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

Настройте или обновите CLI

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

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

Windows macOS Linux

Окна

Установить 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.

Используйте CLI с системами CI

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

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

Firebase CLI обнаружит и будет использовать Application Default Credentials, если они установлены. Самый простой способ аутентификации CLI в CI и других headless-средах — настроить Application Default Credentials .

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

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

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

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

   firebase login:ci

3. Перейдите по предоставленному URL-адресу, затем войдите в систему, используя учетную запись 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

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

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 CLI управляет развертыванием кода и ресурсов в вашем проекте Firebase, включая:

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

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

firebase deploy

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

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

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

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

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

Конфликты развертывания правил безопасности

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

Другой вариант избежать конфликтов развертывания — использовать частичное развертывание и определять правила только в консоли Firebase .

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

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

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

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

В настоящее время невозможно откатить выпуски правил безопасности для Firebase Realtime Database , Cloud Storage for Firebase или Cloud Firestore .

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

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

firebase deploy --only hosting,storage

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

Развертывание определенных функций

При развертывании функций вы можете ориентироваться на конкретные функции. Например:

firebase deploy --only functions:function1

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

Другой вариант — сгруппировать функции в экспортные группы в файле /functions/index.js . Группировка функций позволяет развертывать несколько функций с помощью одной команды.

Например, вы можете написать следующие функции для определения groupA и groupB :

var functions = require('firebase-functions/v1');

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

В этом примере отдельный файл functions/groupB.js содержит дополнительные функции, которые специально определяют функции в groupB . Например:

var functions = require('firebase-functions/v1');

exports.function3 = functions.storage.object().onChange(...);
exports.function4 = functions.analytics.event('in_app_purchase').onLog(...);

В этом примере вы можете развернуть все функции groupA , выполнив следующую команду из каталога вашего проекта:

firebase deploy --only functions:groupA

Или вы можете выбрать определенную функцию в группе, выполнив следующую команду:

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

Удалить функции

Firebase CLI поддерживает следующие команды и параметры для удаления ранее развернутых функций:

• Удаляет все функции, соответствующие указанному имени во всех регионах:

  firebase functions:delete FUNCTION-1_NAME

• Удаляет указанную функцию, работающую в регионе, отличном от региона по умолчанию:

  firebase functions:delete FUNCTION-1_NAME --region REGION_NAME

• Удаляет более одной функции:

  firebase functions:delete FUNCTION-1_NAME FUNCTION-2_NAME

• Удаляет указанную группу функций:

  firebase functions:delete GROUP_NAME

• Обходит запрос подтверждения:

  firebase functions:delete FUNCTION-1_NAME --force

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

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

Чтобы настроить predeploy или postdeploy hooks, добавьте 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 hooks для любого из ресурсов, которые вы можете развернуть . Обратите внимание, что запуск 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 которые необходимо развернуть.

Управление несколькими экземплярами Realtime Database

Проект Firebase может иметь несколько экземпляров Firebase Realtime Database . По умолчанию команды CLI взаимодействуют с вашим экземпляром базы данных по умолчанию .

Однако вы можете взаимодействовать с экземпляром базы данных, отличным от экземпляра по умолчанию, используя --instance DATABASE_NAME флаг. Следующие команды поддерживают флаг --instance :

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

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

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

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

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

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

Команды App Distribution

Команды App Hosting

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

Команды Cloud Firestore

Cloud Functions for Firebase

Более подробную информацию см. в документации по настройке среды .

Команды Crashlytics

Команды Data Connect

Эти команды и варианты их использования более подробно описаны в справочном руководстве по Data Connect CLI .

Команды Extensions

Команды издателя Extensions

Hosting команд

Команды Realtime Database

Обратите внимание, что вы можете создать свой начальный экземпляр Realtime Database по умолчанию в консоли Firebase или с помощью общего рабочего процесса firebase init или специального процесса firebase init database .

После создания экземпляров вы можете управлять ими, как описано в разделе Управление несколькими экземплярами Realtime Database .

Команды Remote Config