Firebase CLI ( GitHub ) предоставляет множество инструментов для управления, просмотра и развертывания проектов Firebase.
Перед использованием Firebase CLI настройте проект Firebase .
Настройте или обновите CLI
Установите Firebase CLI
Вы можете установить Firebase CLI, используя метод, который соответствует вашей операционной системе, уровню опыта и/или варианту использования. Независимо от того, как вы устанавливаете CLI, у вас есть доступ к тем же функциям и команде firebase .
Окна
Установить Firebase CLI для Windows можно одним из следующих способов:
| Вариант | Описание | Рекомендуется для... |
|---|---|---|
| автономный двоичный файл | Загрузите автономный двоичный файл для CLI. Затем вы можете получить доступ к исполняемому файлу, чтобы открыть оболочку, в которой вы можете запустить команду firebase . | Новые разработчики Разработчики, не использующие или незнакомые с Node.js |
| нпм | Используйте npm (менеджер пакетов Node) для установки CLI и включения глобально доступной команды firebase . | Разработчики, использующие Node.js |
автономный двоичный файл
Чтобы загрузить и запустить двоичный файл для Firebase CLI, выполните следующие действия:
Загрузите двоичный файл Firebase CLI для Windows .
Получите доступ к двоичному файлу, чтобы открыть оболочку, в которой вы можете выполнить команду
firebase.Продолжайте входить в систему и тестировать CLI .
нпм
Чтобы использовать npm (менеджер пакетов Node) для установки Firebase CLI, выполните следующие действия:
Установите Node.js с помощью nvm-windows (Node Version Manager). Установка Node.js автоматически устанавливает инструменты команд
npm.Установите Firebase CLI через
npm, выполнив следующую команду:npm install -g firebase-tools
Эта команда включает глобально доступную команду
firebase.Продолжайте входить в систему и тестировать CLI .
macOS или Linux
Установить Firebase CLI для macOS или Linux можно одним из следующих способов:
| Вариант | Описание | Рекомендуется для... |
|---|---|---|
| автоматический скрипт установки | Запустите одну команду, которая автоматически определит вашу операционную систему, загрузит последнюю версию CLI, а затем включит глобально доступную команду firebase . | Новые разработчики Разработчики, не использующие или незнакомые с Node.js Автоматизированные развертывания в среде CI/CD |
| автономный двоичный файл | Загрузите автономный двоичный файл для CLI. Затем вы можете настроить и запустить двоичный файл в соответствии с вашим рабочим процессом. | Полностью настраиваемые рабочие процессы с использованием CLI |
| нпм | Используйте npm (менеджер пакетов Node) для установки CLI и включения глобально доступной команды firebase . | Разработчики, использующие Node.js |
скрипт автоматической установки
Чтобы установить Firebase CLI с помощью скрипта автоматической установки, выполните следующие действия:
Выполните следующую команду cURL:
curl -sL https://firebase.tools | bash
Этот скрипт автоматически определяет вашу операционную систему, загружает последнюю версию Firebase CLI, а затем включает глобально доступную команду
firebase.Продолжайте входить в систему и тестировать CLI .
Дополнительные примеры и подробности о скрипте автоматической установки см. в исходном коде скрипта на firebase.tools .
автономный двоичный файл
Чтобы загрузить и запустить двоичный файл Firebase CLI, соответствующий вашей ОС, выполните следующие действия:
Загрузите двоичный файл Firebase CLI для вашей ОС: macOS | Linux
(Необязательно) Настройте глобально доступную команду
firebase.- Сделайте двоичный файл исполняемым, выполнив команду
chmod +x ./firebase_tools. - Добавьте путь к исполняемому файлу в PATH.
- Сделайте двоичный файл исполняемым, выполнив команду
Продолжайте входить в систему и тестировать CLI .
нпм
Чтобы использовать npm (менеджер пакетов Node) для установки Firebase CLI, выполните следующие действия:
Установите Node.js с помощью nvm (менеджер версий Node).
Установка Node.js автоматически устанавливает инструменты командnpm.Установите Firebase CLI через
npm, выполнив следующую команду:npm install -g firebase-tools
Эта команда включает глобально доступную команду
firebase.Продолжайте входить в систему и тестировать CLI .
Войдите в систему и протестируйте Firebase CLI.
После установки CLI необходимо пройти аутентификацию. Затем вы можете подтвердить аутентификацию, перечислив свои проекты Firebase.
Войдите в Firebase, используя свою учетную запись Google, выполнив следующую команду:
firebase login
Эта команда подключает ваш локальный компьютер к Firebase и предоставляет вам доступ к вашим проектам Firebase.
Проверьте, что CLI правильно установлен и имеет доступ к вашей учетной записи, перечислив ваши проекты Firebase. Выполните следующую команду:
firebase projects:list
Отображаемый список должен совпадать с проектами Firebase, перечисленными в консоли Firebase .
Обновите CLI до последней версии
Как правило, рекомендуется использовать самую последнюю версию Firebase CLI.
Способ обновления версии CLI зависит от вашей операционной системы и способа установки CLI.
Окна
- автономный двоичный файл : загрузите новую версию , затем замените ее в своей системе
- npm : Запустите
npm install -g firebase-tools
macOS
- скрипт автоматической установки : Запустите
curl -sL https://firebase.tools | upgrade=true bash - автономный двоичный файл : загрузите новую версию , затем замените ее в своей системе
- npm : Запустите
npm install -g firebase-tools
линукс
- скрипт автоматической установки : Запустите
curl -sL https://firebase.tools | upgrade=true bash - автономный двоичный файл : загрузите новую версию , затем замените ее в своей системе
- npm : Запустите
npm install -g firebase-tools
Используйте CLI с системами CI
При использовании CLI с системами CI мы рекомендуем вам проходить аутентификацию с использованием учетных данных приложения по умолчанию.
(Рекомендуется) Использовать учетные данные приложения по умолчанию
Firebase CLI обнаружит и будет использовать Application Default Credentials, если они установлены. Самый простой способ аутентификации CLI в CI и других headless-средах — настроить Application Default Credentials .
(Устаревшая версия) Используйте FIREBASE_TOKEN
В качестве альтернативы вы можете выполнить аутентификацию с помощью FIREBASE_TOKEN . Это менее безопасно, чем учетные данные приложения по умолчанию, и больше не рекомендуется.
На компьютере с браузером установите Firebase CLI .
Начните процесс входа, выполнив следующую команду:
firebase login:ci
Перейдите по предоставленному URL-адресу, затем войдите в систему, используя учетную запись Google.
Распечатать новый токен обновления . Текущий сеанс CLI не будет затронут.
Сохраните выходной токен в безопасном, но доступном месте в вашей системе CI.
Используйте этот токен при запуске команд
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 CLI попросит вас выполнить следующие задачи:
Выберите проект Firebase по умолчанию.
На этом шаге текущий каталог проекта связывается с проектом Firebase, чтобы команды, специфичные для проекта (например,
firebase deploy), запускались для соответствующего проекта Firebase.Также можно связать несколько проектов Firebase (например, промежуточный проект и производственный проект) с одним и тем же каталогом проекта.
Выберите нужные продукты Firebase для настройки в вашем проекте Firebase.
На этом этапе вам будет предложено задать конфигурации для определенных файлов для выбранных продуктов. Более подробную информацию об этих конфигурациях см. в документации по конкретному продукту (например, Hosting ). Обратите внимание, что вы всегда можете запустить
firebase initпозже, чтобы настроить больше продуктов Firebase.
В конце инициализации Firebase автоматически создает следующие два файла в корневом каталоге вашего локального приложения:
Файл конфигурации
firebase.json, в котором указана конфигурация вашего проекта.Файл
.firebaserc, в котором хранятся псевдонимы вашего проекта.
Файл firebase.json
Команда firebase init создает файл конфигурации firebase.json в корневом каталоге вашего проекта.
Файл firebase.json необходим для развертывания ресурсов с помощью Firebase CLI , поскольку он определяет, какие файлы и настройки из каталога вашего проекта развертываются в вашем проекте Firebase. Поскольку некоторые настройки могут быть определены либо в каталоге вашего проекта, либо в консоли Firebase , убедитесь, что вы разрешили все потенциальные конфликты развертывания .
Большинство опций Firebase Hosting можно настроить непосредственно в файле firebase.json . Однако для других служб Firebase, которые можно развернуть с помощью Firebase CLI , команда firebase init создает специальные файлы, в которых можно определить настройки для этих служб, например файл index.js для Cloud Functions . Вы также можете настроить predeploy или postdeploy hooks в файле firebase.json .
Ниже приведен пример файла firebase.json с настройками по умолчанию, если во время инициализации вы выбрали Firebase Hosting , Cloud Firestore и Cloud Functions for Firebase (с выбранными параметрами источника и lint 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, выполните любую из следующих команд из каталога вашего проекта.
| Команда | Описание |
|---|---|
firebase use | Просмотр списка определенных в данный момент псевдонимов для вашего каталога проекта. |
firebase use \ | Указывает, что все команды должны выполняться в отношении указанного проекта Firebase. CLI использует этот проект как текущий «активный проект». |
firebase use --clear | Очищает активный проект. Запустите |
firebase use \ | Удаляет псевдоним из каталога вашего проекта. |
Вы можете переопределить то, что используется в качестве текущего активного проекта, передав флаг --project с любой командой CLI. Например: вы можете настроить CLI на запуск проекта Firebase, которому вы назначили псевдоним staging . Если вы хотите запустить одну команду для проекта Firebase, которому вы назначили псевдоним 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 .
| Синтаксис флага | Развернутая услуга или функция |
|---|---|
--only hosting | Контент Firebase Hosting |
--only database | Правила Firebase Realtime Database |
--only dataconnect | Схемы и коннекторы Firebase Data Connect |
--only storage | Правила Cloud Storage for Firebase |
--only firestore | Правила и индексы Cloud Firestore для всех настроенных баз данных |
--only functions | Cloud Functions for Firebase (возможны более конкретные версии этого флага ) |
Развертывание определенных функций
При развертывании функций вы можете ориентироваться на конкретные функции. Например:
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
| Команда | Описание |
|---|---|
| помощь | Отображает справочную информацию о CLI или конкретных командах. |
| инициализация | Связывает и настраивает новый проект Firebase в текущем каталоге. Эта команда создает файл конфигурации firebase.json в текущем каталоге. |
| авторизоваться | Аутентифицирует CLI с помощью вашего аккаунта Google. Требуется доступ к веб-браузеру. Чтобы войти в CLI в удаленных средах, которые не разрешают доступ к localhost , используйте--no-localhost . |
| логин:ci | Генерирует токен аутентификации для использования в неинтерактивных средах. |
| выйти из системы | Выход из учетной записи Google из CLI. |
| открыть | Открывает браузер для соответствующих ресурсов проекта. |
| проекты:список | Список всех проектов Firebase, к которым у вас есть доступ. |
| использовать | Устанавливает активный проект Firebase для CLI. Управляет псевдонимами проектов . |
Команды управления проектами
| Команда | Описание | |
|---|---|---|
| Управление проектами Firebase | ||
| проекты:addfirebase | Добавляет ресурсы Firebase в существующий проект Google Cloud . | |
| проекты:создать | Создает новый проект Google Cloud , затем добавляет ресурсы Firebase в новый проект. | |
| проекты:список | Список всех проектов Firebase, к которым у вас есть доступ. | |
| Управление приложениями Firebase (iOS, Android, Web) | ||
| приложения:создать | Создает новое приложение Firebase в активном проекте. | |
| приложения:список | Список зарегистрированных приложений Firebase в активном проекте. | |
| приложения:sdkconfig | Распечатывает конфигурацию служб Google для приложения Firebase. | |
| настройка:веб | Устарело. Вместо этого используйте apps:sdkconfig и укажите web в качестве аргумента платформы.Распечатывает конфигурацию служб Google для веб-приложения Firebase. | |
| Управление хэшами сертификатов SHA (только для Android) | ||
| приложения:android:sha:create \ FIREBASE_APP_ID SHA_HASH | Добавляет указанный хэш сертификата SHA в указанное приложение Firebase Android. | |
| приложения:android:sha:удалить \ FIREBASE_APP_ID SHA_HASH | Удаляет указанный хэш сертификата SHA из указанного приложения Firebase Android. | |
| приложения:android:sha:list \ FIREBASE_APP_ID | Выводит список хешей сертификатов SHA для указанного приложения Firebase Android. | |
Развертывание и локальное развитие
Эти команды позволяют вам развертывать и взаимодействовать с вашим сайтом Firebase Hosting .
| Команда | Описание |
|---|---|
| развертывать | Развертывает код и активы из каталога вашего проекта в активный проект. Для Firebase Hosting требуется файл конфигурации firebase.json . |
| служить | Запускает локальный веб-сервер с конфигурацией Firebase Hosting . Для Firebase Hosting требуется файл конфигурации firebase.json . |
Команды App Distribution
| Команда | Описание |
|---|---|
| appdistribution:распространение \ --app FIREBASE_APP_ID | Делает сборку доступной для тестировщиков. |
| appdistribution:тестеры:добавить | Добавляет тестировщиков в проект. |
| appdistribution:тестеры:удалить | Удаляет тестировщиков из проекта. |
Команды App Hosting
| Команда | Описание |
|---|---|
| apphosting:бэкэнды:создать \ --project PROJECT_ID \ --location REGION --app APP_ID | Создает коллекцию управляемых ресурсов, связанных с единой кодовой базой, которая включает в себя бэкэнд App Hosting . При желании укажите существующее веб-приложение Firebase по его идентификатору приложения Firebase. |
| apphosting:бэкэнды:получить \ BACKEND_ID \ --project PROJECT_ID \ --местоположение REGION | Извлекает определенные данные, включая общедоступный URL-адрес, бэкэнда. |
| apphosting:бэкэнды:список \ --проект PROJECT_ID | Извлекает список всех активных бэкэндов, связанных с проектом. |
| firebase apphosting:бэкенды:удалить \ BACKEND_ID \ --project PROJECT_ID \ --местоположение REGION | Удаляет бэкэнд из проекта. |
| firebase apphosting:config:export \ --project PROJECT_ID \ --secrets ENVIRONMENT_NAME | Экспортирует секреты для использования в эмуляции приложения. По умолчанию используются секреты, хранящиеся в apphosting.yaml , или используется --secrets для указания любой среды, имеющей соответствующий файл apphosting. ENVIRONMENT_NAME .yaml . |
| firebase apphosting:rollouts:create \ BACKEND_ID \ --git_branch BRANCH_NAME \ --git_commit COMMIT_ID | Создает развертывание, запускаемое вручную. При желании можно указать последний коммит в ветке или конкретный коммит. Если параметры не указаны, запрашивает выбор из списка веток. |
| apphosting:secrets:set KEY --project PROJECT_ID \ --location REGION \ --data-file DATA_FILE_PATH | Сохраняет секретные материалы в Secret Manager. При желании укажите путь к файлу, из которого следует читать секретные данные. Установите _ , чтобы читать секретные данные из стандартного ввода. |
| apphosting:secrets:grantaccess KEY BACKEND_ID \ --project PROJECT_ID \ --местоположение REGION | Предоставляет учетной записи внутренней службы доступ к предоставленному секрету, чтобы App Hosting мог получить к нему доступ во время сборки или выполнения. |
| apphosting:секреты:опишите KEY \ --проект PROJECT_ID | Получает метаданные для секрета и его версий. |
| firebase apphosting:секреты:доступ \ KEY[@version] \ --проект PROJECT_ID | Доступ к секретному значению, заданному секретом и его версией. По умолчанию доступ к последней версии. |
Команды Authentication (управления пользователями)
| Команда | Описание |
|---|---|
| аутентификация:экспорт | Экспортирует учетные записи пользователей активного проекта в файл JSON или CSV. Для получения более подробной информации см. страницу auth:import и auth:export . |
| аутентификация:импорт | Импортирует учетные записи пользователей из файла JSON или CSV в активный проект. Для получения более подробной информации см. страницу auth:import и auth:export . |
Команды Cloud Firestore
| Команда | Описание |
|---|---|
| пожарный магазин:местоположения | Перечислите доступные расположения для вашей базы данных Cloud Firestore . |
| firestore:databases:create DATABASE_ID | Создайте экземпляр базы данных в собственном режиме в вашем проекте Firebase. Команда принимает следующие флаги:
|
| firestore:базы данных:список | Перечислите базы данных в вашем проекте Firebase. |
| firestore:databases:получить DATABASE_ID | Получите конфигурацию базы данных для указанной базы данных в вашем проекте Firebase. |
| firestore:databases:обновить DATABASE_ID | Обновите конфигурацию указанной базы данных в вашем проекте Firebase. Требуется по крайней мере один флаг. Команда принимает следующие флаги:
|
| firestore:databases:delete DATABASE_ID | Удалите базу данных в вашем проекте Firebase. |
| firestore:индексы | Выведите список индексов для базы данных в вашем проекте Firebase. Команда принимает следующий флаг:
|
| firestore:удалить | Удаляет документы в базе данных активного проекта. Используя CLI, вы можете рекурсивно удалить все документы в коллекции. Обратите внимание, что удаление данных Cloud Firestore с помощью CLI влечет за собой расходы на чтение и удаление. Для получения дополнительной информации см. раздел Понимание выставления счетов Cloud Firestore . Команда принимает следующий флаг:
|
Cloud Functions for Firebase
| Команда | Описание |
|---|---|
| функции:config:clone | Клонирует среду другого проекта в активный проект Firebase. |
| функции:config:get | Извлекает существующие значения конфигурации Cloud Functions активного проекта. |
| функции:config:set | Сохраняет значения конфигурации времени выполнения Cloud Functions активного проекта. |
| функции:config:unset | Удаляет значения из конфигурации времени выполнения активного проекта. |
| функции:журнал | Читает журналы из развернутых Cloud Functions . |
Более подробную информацию см. в документации по настройке среды .
Команды Crashlytics
| Команда | Описание |
|---|---|
| crashlytics:файл_сопоставления:генерировать_идентификатор \ --resource-file= PATH/TO/ANDROID_RESOURCE.XML | Создает уникальный идентификатор файла сопоставления в указанном файле ресурсов Android (XML). |
| crashlytics:файл_сопоставления:загрузка \ --app= FIREBASE_APP_ID \ --resource-file= PATH/TO/ANDROID_RESOURCE.XML \ PATH/TO/MAPPING_FILE.TXT | Загружает совместимый с Proguard файл сопоставления (TXT) для этого приложения и связывает его с идентификатором файла сопоставления, объявленным в указанном файле ресурсов Android (XML). |
| crashlytics:символы:загрузка \ --app= FIREBASE_APP_ID \ PATH/TO/SYMBOLS | Создает совместимый с Crashlytics файл символов для сбоев собственной библиотеки на Android и загружает его на серверы Firebase. |
Команды Data Connect
Эти команды и варианты их использования более подробно описаны в справочном руководстве по Data Connect CLI .
| Команда | Описание |
|---|---|
| dataconnect:услуги:список | Перечисляет все развернутые службы Data Connect в вашем проекте Firebase. |
| dataconnect:sql:diff \ SERVICE_ID | Для указанной службы отображает различия между локальной схемой Data Connect и схемой вашей базы данных Cloud SQL. |
| dataconnect:sql:migrate \ --сила \ SERVICE_ID | Переносит схему базы данных Cloud SQL в соответствии с локальной схемой Data Connect . |
| dataconnect:sql:grant\ --role= ROLE \ --email= EMAIL \ SERVICE_ID | Предоставляет роль SQL указанному пользователю или учетной записи службы по электронной почте. Для флага --role назначается одна из следующих ролей SQL: owner , writer или reader .Для флага --email укажите адрес электронной почты пользователя или учетной записи службы, которым необходимо предоставить роль. |
| dataconnect:sdk:generate | Генерирует типизированные SDK для ваших коннекторов Data Connect . |
Команды Extensions
| Команда | Описание |
|---|---|
| доб. | Отображает информацию о том, как использовать команды Firebase Extensions . Список экземпляров расширений, установленных в активном проекте. |
| доб:настроить \ EXTENSION_INSTANCE_ID | Изменяет значения параметров экземпляра расширения в манифесте расширения . |
| доб:инфо \ PUBLISHER_ID/EXTENSION_ID | Выводит подробную информацию о расширении. |
| доб:установить \ PUBLISHER_ID/EXTENSION_ID | Добавляет новый экземпляр расширения в манифест расширения . |
| доб:список | Перечисляет все экземпляры расширений, установленные в проекте Firebase. Печатает идентификатор экземпляра для каждого расширения. |
| доб:удалить \ EXTENSION_INSTANCE_ID | Удаляет экземпляр расширения из манифеста расширения . |
| доб:обновление \ EXTENSION_INSTANCE_ID | Обновляет экземпляр расширения до последней версии в манифесте расширения . |
| доб:экспорт | Экспортирует все установленные экземпляры расширения из вашего проекта в манифест расширения . |
Команды издателя Extensions
| Команда | Описание |
|---|---|
| доб:дев:инициализация | Инициализирует скелетную кодовую базу для нового расширения в текущем каталоге. |
| доб:dev:list \ PUBLISHER_ID | Выводит список всех расширений, загруженных издателем. |
| доб:дев:регистр | Регистрирует проект Firebase как проект издателя расширений . |
| ext:dev:deprecate \ PUBLISHER_ID/EXTENSION_ID \ VERSION_PREDICATE | Устаревание версий расширений, соответствующих предикату версии. Предикат версии может быть отдельной версией (например, 1.0.0 ) или диапазоном версий (например >1.0.0 ).Если предикат версии не указан, все версии этого расширения считаются устаревшими. |
| ext:dev:undeprecate \ PUBLISHER_ID/EXTENSION_ID \ VERSION_PREDICATE | Отменяет поддержку версий расширений, соответствующих предикату версии. Предикат версии может быть отдельной версией (например, 1.0.0 ) или диапазоном версий (например >1.0.0 ).Если предикат версии не указан, отменяет устаревание всех версий этого расширения. |
| доб:дев:загрузка \ PUBLISHER_ID/EXTENSION_ID | Загружает новую версию расширения. |
| доб:дев:использование \ PUBLISHER_ID | Отображает количество установок и показатели использования расширений, загруженных издателем. |
Hosting команд
| Команда | Описание |
|---|---|
| хостинг:отключить | Прекращает обслуживание трафика Firebase Hosting для активного проекта Firebase. После выполнения этой команды на URL-адресе Hosting вашего проекта отобразится сообщение «Сайт не найден». |
| Управление Hosting сайтов | |
| хостинг firebase:сайты:создать \ SITE_ID | Создает новый сайт Hosting в активном проекте Firebase, используя указанный (Необязательно) Укажите существующее веб-приложение Firebase для связи с новым сайтом, передав следующий флаг: |
| хостинг firebase:сайты:удалить \ SITE_ID | Удаляет указанный Hosting сайт Перед удалением сайта CLI отображает запрос на подтверждение. (Необязательно) Пропустите запрос подтверждения, передав следующие флаги: |
| хостинг firebase:sites:get \ SITE_ID | Извлекает информацию об указанном сайте Hosting |
| хостинг firebase:сайты:список | Список всех Hosting сайтов для активного проекта Firebase |
| Управление каналами предварительного просмотра | |
| хостинг firebase:канал:создать \ CHANNEL_ID | Создает новый канал предварительного просмотра на сайте Hosting по умолчанию, используя указанный Эта команда не развертывается в канале. |
| хостинг firebase:канал:удалить \ CHANNEL_ID | Удаляет указанный канал предварительного просмотра Вы не можете удалить прямой эфир сайта. |
| хостинг firebase:канал:развертывание \ CHANNEL_ID | Развертывает ваш Hosting контент и конфигурацию на указанном канале предварительного просмотра. Если канал предварительного просмотра еще не существует, эта команда создает канал на сайте Hosting по умолчанию перед развертыванием на канале. |
| хостинг firebase:канал:список | Перечисляет все каналы (включая «живой» канал) на сайте Hosting по умолчанию |
| хостинг firebase:канал:открыть \ CHANNEL_ID | Открывает браузер по указанному URL-адресу канала или возвращает URL-адрес, если открытие в браузере невозможно. |
| Клонирование версий | |
| хостинг firebase:клон \ SOURCE_SITE_ID : SOURCE_CHANNEL_ID \ TARGET_SITE_ID : TARGET_CHANNEL_ID | Клонирует последнюю развернутую версию на указанном «исходном» канале в указанный «целевой» канал. Эта команда также развертывает указанный "целевой" канал. Если "целевой" канал еще не существует, эта команда создает новый канал предварительного просмотра на "целевом" сайте Hosting перед развертыванием на канале. |
| хостинг firebase:клон \ SOURCE_SITE_ID :@ VERSION_ID \ TARGET_SITE_ID : TARGET_CHANNEL_ID | Клонирует указанную версию в указанный «целевой» канал. Эта команда также развертывает указанный "целевой" канал. Если "целевой" канал еще не существует, эта команда создает новый канал предварительного просмотра на "целевом" сайте Hosting перед развертыванием на канале. Вы можете найти |
Команды Realtime Database
Обратите внимание, что вы можете создать свой начальный экземпляр Realtime Database по умолчанию в консоли Firebase или с помощью общего рабочего процесса firebase init или специального процесса firebase init database .
После создания экземпляров вы можете управлять ими, как описано в разделе Управление несколькими экземплярами Realtime Database .
| Команда | Описание |
|---|---|
| база данных:получить | Избирает данные из базы данных Active Project и отображает их как JSON. Поддерживает запросы на индексированные данные. |
| База данных: экземпляры: создать | Создает экземпляр базы данных с указанным именем экземпляра. Принимает опцию --location для создания базы данных в указанном регионе. Чтобы использовать названия регионов с этой опцией, см . Select Locations для вашего проекта . Если для текущего проекта не существует экземпляра базы данных, вам предложено запустить поток firebase init для создания экземпляра. |
| База данных: экземпляры: список | Перечислите все экземпляры базы данных для этого проекта. Принимает опцию --location базы данных в указанном регионе. Для использования имен регионов с этой опцией см . Select Locations для вашего проекта . |
| База данных: профиль | Создает профиль операций в базе данных Active Project. Для получения более подробной информации обратитесь к типам работы Realtime Database . |
| База данных: push | Толкает новые данные в список в указанном месте в базе данных активного проекта. Берет ввод из файла, stdin или аргумента командной строки. |
| База данных: удалить | Удаляет все данные в указанном месте в базе данных активного проекта. |
| База данных: SET | Заменяет все данные в указанном месте в базе данных активного проекта. Берет ввод из файла, stdin или аргумента командной строки. |
| База данных: обновление | Выполняет частичное обновление в указанном месте в базе данных активного проекта. Берет ввод из файла, stdin или аргумента командной строки. |
Команды Remote Config
| Команда | Описание |
|---|---|
| RemoteConfig: Версии: список \ -limit NUMBER_OF_VERSIONS | Перечисляет самые последние десять версий шаблона. Укажите 0 , чтобы вернуть все существующие версии или при желании пройти опцию --limit , чтобы ограничить количество возвращаемых версий. |
| RemoteConfig: Get \ --v, version_number VERSION_NUMBER -O, выходное FILENAME | Получает шаблон по версии (по умолчанию в последнюю версию) и выводит группы параметров, параметры, имена условий и версию в таблицу. При желании вы можете написать выход в указанный файл с -o, FILENAME . |
| remoteConfig: rovkback \ --v, version_number VERSION_NUMBER --сила | Обратает шаблон Remote Config на указанный предыдущий номер версии или по умолчанию к непосредственной предыдущей версии (текущая версия -1). Если не пройден --force y/n , прежде чем приступить к откату. |