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

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

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

Как настроить или обновить CLI

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

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

Windows macOS Linux

Windows

Установить Firebase CLI для Windows можно одним из следующих способов:

macOS или Linux

Установить Firebase CLI для macOS или Linux можно одним из следующих способов:

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

После установки CLI необходимо пройти аутентификацию. Затем вы можете подтвердить аутентификацию, перечислив свои проекты Firebase.

1. Войдите в Firebase с аккаунтом Google, выполнив следующую команду:

   firebase login

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

2. Проверьте, правильно ли установлен интерфейс командной строки и есть ли у него доступ к вашему аккаунту. Для этого запросите список проектов Firebase. Выполните следующую команду:

   firebase projects:list

   Список должен совпадать со списком проектов Firebase в консоли Firebase.

Как обновить CLI до последней версии

Как правило, рекомендуется использовать последнюю версию Firebase CLI.

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

Как удалить интерфейс командной строки Firebase

Способ удаления CLI зависит от вашей операционной системы и способа установки CLI.

Как использовать CLI с системами непрерывной интеграции

При использовании CLI с системами CI мы рекомендуем выполнять аутентификацию с помощью Application Default Credentials.

(Рекомендуется) Использовать Application Default Credentials

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

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

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

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

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

   firebase login:ci

3. Перейдите по указанному URL и войдите в аккаунт Google.

4. Напечатать новый токен обновления. Текущий сеанс CLI не будет затронут.

5. Сохраните полученный токен в безопасном, но доступном месте в вашей системе CI.

6. Используйте этот токен при выполнении команд firebase. Вы можете выбрать один из двух вариантов:

   • Вариант 1. Сохраните токен как переменную среды FIREBASE_TOKEN. Система автоматически использует токен.

   • Вариант 2. Выполните все команды firebase с флагом --token TOKEN в системе непрерывной интеграции.
     Токены загружаются в следующем порядке: флаг, переменная среды, нужный проект Firebase.

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

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

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

firebase init

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

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

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

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

• Выберите продукты Firebase, которые нужно настроить в проекте Firebase.

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

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

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

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

Файл firebase.json

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

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

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

В файле firebase.json ниже приведены примеры конфигурации для многих сервисов Firebase. В нем также показаны такие функции, как настройка нескольких баз кода Cloud Functions, Local Emulator Suite и шаблона Remote Config. Обратите внимание, что файл firebase.json для любого проекта будет содержать только конфигурации сервисов Firebase, настроенных для этого проекта (например, только Firebase Hosting и Cloud Functions). Добавление ключа $schema позволяет выполнять проверку и автозаполнение во многих редакторах кода.

    {
      "$schema": "https://raw.githubusercontent.com/firebase/firebase-tools/master/schema/firebase-config.json",
      "hosting": {
        "public": "public",
        "ignore": [
          "firebase.json",
          "**/.*",
          "**/node_modules/**"
        ],
        "cleanUrls": true,
        "trailingSlash": false
      },
      "apphosting": {
        "backendId": "my-app",
        "rootDir": "backend",
        "ignore": [
          "firebase.json",
          "**/.*",
          "**/node_modules/**"
        ]
      },
      "firestore": {
        "rules": "firestore.rules",
        "indexes": "firestore.indexes.json"
      },
      "storage": {
        "rules": "storage.rules"
      },
      "database": {
        "rules": "database.rules.json"
      },
      "dataconnect": {
        "source": "dataconnect",
        "location": "us-central1"
      },
      "functions": [
        {
          "source": "functions",
          "codebase": "default",
          "ignore": [
            "**/.*",
            "**/node_modules/**"
          ],
          "predeploy": [
            "npm --prefix \"$RESOURCE_DIR\" run lint",
            "npm --prefix \"$RESOURCE_DIR\" run build"
          ]
        }
      ],
      "emulators": {
        "auth": {
          "port": 9099
        },
        "functions": {
          "port": 5001
        },
        "firestore": {
          "port": 8080
        },
        "hosting": {
          "port": 5000
        },
        "storage": {
          "port": 9199
        },
        "ui": {
          "enabled": true,
          "port": 4000
        },
        "singleProjectMode": true
      },
      "extensions": {
        "my-storage-resizer": "firebase/storage-resize-images@^0.1.0"
      },
      "auth": {
        "providers": {
          "anonymous": true,
          "emailPassword": true,
          "googleSignIn": {
            "oAuthBrandDisplayName": "My App",
            "supportEmail": "support@myapp.com"
          }
        }
      },
      "remoteconfig": {
        "template": "remoteconfig.template.json"
      }
    }

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

• Чтобы эмулировать функции 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 SQL Connect
• Security Rules (Firebase Realtime Database)
• Security Rules (Cloud Storage for Firebase)
• Security Rules (Cloud Firestore)
• Индексы для Cloud Firestore
• Конфигурация для Authentication

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

firebase deploy

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

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

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

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

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

Как развернуть определенные сервисы Firebase

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

firebase deploy --only hosting,storage

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

Конфликты развертывания для Security Rules

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

Чтобы избежать конфликтов при развертывании, можно использовать частичное развертывание и определять Security Rules только в консоли Firebase.

Как настроить задачи на основе скриптов до и после развертывания

Вы можете подключить скрипты оболочки к команде 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 запускаются все задачи, определенные в файле firebase.json для этапов до и после развертывания. Чтобы выполнить только те задачи, которые связаны с определенным сервисом Firebase, используйте команды частичного развертывания.

Оба приема predeploy и postdeploy выводят стандартные выходные данные и потоки ошибок скриптов в терминал. В случае сбоя:

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

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

В скриптах, выполняемых в хуках predeploy и postdeploy, доступны следующие переменные среды:

• $GCLOUD_PROJECT – идентификатор активного проекта.
• $PROJECT_DIR – корневой каталог, содержащий файл firebase.json.
• $RESOURCE_DIR: (только для скриптов hosting и functions) местоположение каталога, содержащего ресурсы Hosting или Cloud Functions, которые нужно развернуть.

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

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

Как выполнить откат развертывания

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

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

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

Команды администрирования CLI

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

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

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

команды App Distribution;

команды App Hosting;

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

команды Cloud Firestore;

команды Cloud Functions for Firebase;

Подробнее о настройке среды…

команды Crashlytics;

команды SQL Connect;

Подробную информацию об этих командах и примерах их использования можно найти в справочном руководстве по CLI SQL Connect.

команды Extensions;

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

команды Hosting;

команды Realtime Database;

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

После создания экземпляров вы можете управлять ими, как описано в разделе Как управлять отдельными экземплярами с помощью интерфейса командной строки и взаимодействовать с ними.

команды Remote Config;

Подробнее об этих командах и примерах их использования рассказывается в статье Как изменять Remote Config программным способом.