Справочник по интерфейсу командной строки 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

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

Для настройки хуков 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 которые необходимо развернуть.

Управление несколькими экземплярами 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

For more information, refer to the environment configuration documentation .

Crashlytics commands

Data Connect commands

These commands and their use cases are covered in more detail in the Data 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 discussed in Manage multiple Realtime Database instances .

Remote Config commands