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

Команда firebase init поможет вам настроить каталог проекта и некоторые продукты Firebase. Во время инициализации проекта интерфейс командной строки Firebase просит вас выполнить следующие задачи:

• Выберите нужные продукты Firebase для настройки в своем проекте Firebase.

  На этом шаге вам будет предложено установить конфигурации для определенных файлов для выбранных продуктов. Более подробную информацию об этих конфигурациях можно найти в документации конкретного продукта (например, Hosting ). Обратите внимание, что вы всегда можете запустить firebase init позже, чтобы настроить дополнительные продукты Firebase.

• Выберите проект Firebase по умолчанию.

  На этом этапе текущий каталог проекта связывается с проектом Firebase, чтобы команды, специфичные для проекта (например, firebase deploy ), выполнялись для соответствующего проекта Firebase.

  Также можно связать несколько проектов Firebase (например, промежуточный проект и производственный проект) с одним и тем же каталогом проекта.

В конце инициализации Firebase автоматически создает следующие два файла в корне вашего локального каталога приложения:

• Файл конфигурации firebase.json , в котором перечислена конфигурация вашего проекта.

• Файл .firebaserc , в котором хранятся псевдонимы вашего проекта.

Файл firebase.json

Команда firebase init создает файл конфигурации firebase.json в корне каталога вашего проекта.

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

Вы можете настроить большинство параметров Firebase Hosting непосредственно в файле firebase.json . Однако для других сервисов Firebase, которые можно развернуть с помощью Firebase CLI , команда firebase init создает определенные файлы, в которых вы можете определить настройки для этих сервисов, например файл index.js для Cloud Functions . Вы также можете настроить перехватчики перед развертыванием или после развертывания в файле firebase.json .

Ниже приведен пример файла firebase.json с настройками по умолчанию, если во время инициализации вы выбираете Firebase Hosting , Cloud Firestore и Cloud Functions for Firebase (с выбранным источником TypeScript и параметрами проверки).

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

Хотя по умолчанию используется firebase.json , вы можете передать флаг --config PATH , чтобы указать альтернативный файл конфигурации.

Конфигурация для нескольких баз данных Cloud Firestore

Когда вы запускаете firebase init , ваш файл firebase.json будет содержать один ключ firestore соответствующий базе данных вашего проекта по умолчанию, как показано выше.

Если ваш проект содержит несколько баз данных Cloud Firestore , отредактируйте файл firebase.json , чтобы связать разные Cloud Firestore Security Rules и исходные файлы индекса базы данных с каждой базой данных. Измените файл с помощью массива JSON с одной записью для каждой базы данных.

      "firestore": [
        {
          "database": "(default)",
          "rules": "firestore.default.rules",
          "indexes": "firestore.default.indexes.json"
        },
        {
          "database": "ecommerce",
          "rules": "firestore.ecommerce.rules",
          "indexes": "firestore.ecommerce.indexes.json"
        }
      ],

Файлы Cloud Functions которые следует игнорировать при развертывании

Во время развертывания функции CLI автоматически указывает список файлов в каталоге functions которые следует игнорировать. Это предотвращает развертывание на серверной стороне посторонних файлов, которые могут увеличить размер данных вашего развертывания.

Список файлов, игнорируемых по умолчанию, показанный в формате JSON:

"ignore": [
  ".git",
  ".runtimeconfig.json",
  "firebase-debug.log",
  "firebase-debug.*.log",
  "node_modules"
]

Если вы добавляете свои собственные значения для ignore в firebase.json , убедитесь, что вы сохранили (или добавили, если он отсутствует) список файлов, показанный выше.

Управление псевдонимами проектов

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

Добавить псевдоним проекта

Когда вы выбираете проект Firebase во время инициализации проекта , ему автоматически присваивается псевдоним по default . Однако, чтобы позволить командам, специфичным для проекта, запускаться в другом проекте Firebase, но при этом использовать тот же каталог проекта, выполните следующую команду из каталога вашего проекта:

firebase use --add

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

Используйте псевдонимы проектов

Чтобы использовать назначенные псевдонимы проекта Firebase, выполните любую из следующих команд из каталога вашего проекта.

Вы можете переопределить то, что используется в качестве текущего активного проекта, передав флаг --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

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

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

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

firebase init

Команда firebase init снимает вас через настройку каталога проекта и некоторых продуктов Firebase. Во время инициализации проекта CLI Firebase просит вас выполнить следующие задачи:

• Выберите желаемые продукты Firebase для настройки в вашем проекте Firebase.

  Этот шаг побуждает вас установить конфигурации для определенных файлов для выбранных продуктов. Для получения более подробной информации об этих конфигурациях см. В документации конкретного продукта (например, Hosting ). Обратите внимание, что вы всегда можете запустить firebase init , чтобы настроить больше продуктов Firebase.

• Выберите проект Firebase по умолчанию.

  Этот шаг связывает текущий каталог проектов с помощью проекта Firebase, так что команды специфичных для проекта (например, firebase deploy ) работают против соответствующего проекта Firebase.

  Также можно связать несколько проектов Firebase (например, проект по стадии и производственный проект) с тем же каталогом проекта.

В конце инициализации Firebase автоматически создает следующие два файла в корне вашего локального каталога приложений:

• Файл конфигурации firebase.json , в котором перечислены конфигурация вашего проекта.

• Файл .firebaserc , который хранит псевдонимов проекта.

Файл firebase.json

Команда firebase init создает файл конфигурации firebase.json в корне вашего каталога проекта.

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

Вы можете настроить большинство вариантов Firebase Hosting непосредственно в файле firebase.json . Однако для других служб Firebase, которые можно развернуть с помощью CLI Firebase , команда firebase init создает определенные файлы, где вы можете определить настройки для этих служб, такие как файл index.js для Cloud Functions . Вы также можете настроить Predeploy или Postdeploy Hooks в файле firebase.json .

Ниже приведен пример файла firebase.json с настройками по умолчанию, если вы выбираете Firebase Hosting , Cloud Firestore и Cloud Functions for Firebase (с выбранными параметрами TypeScript и Lint) во время инициализации.

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

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

Конфигурация для нескольких баз данных Cloud Firestore

Когда вы запускаете firebase init , ваш файл firebase.json будет содержать один ключ firestore соответствующий базе данных по умолчанию вашего проекта, как показано выше.

Если ваш проект содержит несколько баз данных Cloud Firestore , отредактируйте свой файл firebase.json , чтобы связать различные Cloud Firestore Security Rules и исходные файлы индекса базы данных с каждой базой данных. Измените файл с помощью массива JSON, с одной записью для каждой базы данных.

      "firestore": [
        {
          "database": "(default)",
          "rules": "firestore.default.rules",
          "indexes": "firestore.default.indexes.json"
        },
        {
          "database": "ecommerce",
          "rules": "firestore.ecommerce.rules",
          "indexes": "firestore.ecommerce.indexes.json"
        }
      ],

Cloud Functions файлов игнорировать при развертывании

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

Список файлов, проигнорированных по умолчанию, показан в формате JSON, есть:

"ignore": [
  ".git",
  ".runtimeconfig.json",
  "firebase-debug.log",
  "firebase-debug.*.log",
  "node_modules"
]

Если вы добавите свои собственные значения для ignore в firebase.json , убедитесь, что вы сохраняете (или добавляете, если он отсутствует) список файлов, показанных выше.

Управление псевдонимом проекта

Вы можете связать несколько проектов Firebase с одним и тем же каталогом проекта. Например, вы можете использовать один проект Firebase для постановки, а другой для производства. Используя различные проектные среды, вы можете проверить изменения перед развертыванием до производства. Команда firebase use позволяет переключаться между псевдонями, а также создавать новые псевдонимы.

Добавить псевдоним проекта

Когда вы выбираете проект Firebase во время инициализации проекта , проекту автоматически назначается псевдоним по default . Однако, чтобы позволить командам, специфичным для специфических для проекта, выполнять работу против другого проекта Firebase, но все же использовать один и тот же каталог проектов, запустите следующую команду из вашего каталога проекта:

firebase use --add

Эта команда побуждает вас выбрать еще один проект Firebase и назначить проект в качестве псевдонима. Ассоциация назначений записывается в файл .firebaserc в каталоге проекта.

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

Чтобы использовать назначенные псевдонимы проекта Firebase, запустите любую из следующих команд из вашего каталога проекта.

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

Управление источниками и псевдонимов проекта

В целом, вы должны проверить свой файл .firebaserc в управление источником, чтобы ваша команда обменивалась псевдонимом проекта. Тем не менее, для проектов с открытым исходным кодом или стартовых шаблонов, вы, как правило, не должны проверять свой файл .firebaserc .

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

Подавать и проверить свой проект Firebase на местном уровне

Вы можете просмотреть и проверить свой проект Firebase на местном размещенном URL -адресах перед тем, как развернуть до производства. Если вы хотите только протестировать функции Select, вы можете использовать разделенный запятой список в флаге по команде 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

CLI 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 .

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

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

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

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

В настоящее время невозможно отказаться от выпусков правил безопасности для 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

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

CLI 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

Установите задачи Predeploy и Postdeploy

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

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

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

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

Переменные среды

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

• $GCLOUD_PROJECT : идентификатор проекта активного проекта
• $PROJECT_DIR : корневый каталог, содержащий файл firebase.json
• $RESOURCE_DIR Hosting (только для сценариев hosting functions 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 (user management) commands

Cloud Firestore commands

Cloud Functions for Firebase commands

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