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

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

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

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

Установите интерфейс командной строки Firebase

Вы можете установить 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

Firebase CLI требуется браузер для завершения аутентификации, но CLI полностью совместим с CI и другими автономными средами.

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 управляет развертыванием кода и ресурсов в вашем проекте 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 поддерживает следующие команды и параметры для удаления ранее развернутых функций:

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

  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 для выполнения задач перед или после развертывания. Например, сценарий перед развертыванием может транспилировать код TypeScript в JavaScript, а перехватчик после развертывания может уведомлять администраторов о развертывании нового контента сайта на Firebase Hosting .

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

Например, следующий скрипт представляет собой выражение firebase.json для задачи после развертывания, которая отправляет сообщение 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 запускает все задачи перед и после развертывания, определенные в вашем файле 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 или с помощью рабочего процесса General firebase init или конкретного потока firebase init database .

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

Remote Config