Dokumentacja interfejsu wiersza poleceń Firebase

Wiersz poleceń Firebase (GitHub) udostępnia różne narzędzia do zarządzania, wyświetlania i wdrażania projektów Firebase.

Przed użyciem interfejsu wiersza poleceń Firebase skonfigurować projekt Firebase.

Konfigurowanie lub aktualizowanie interfejsu wiersza poleceń

Zainstaluj interfejs wiersza poleceń Firebase

Interfejs wiersza poleceń Firebase możesz zainstalować, stosując metodę odpowiednią do Twojego systemu operacyjnego, poziomu doświadczenia lub przypadku użycia. Niezależnie od sposobu instalacji interfejsu wiersza poleceń, masz dostęp do tych samych funkcji co polecenie firebase.

Windows macOS Linux

Windows

Interfejs wiersza poleceń Firebase dla systemu Windows można zainstalować, korzystając z jednej z tych opcji:

macOS lub Linux

Aby zainstalować interfejs wiersza poleceń Firebase na komputerze z systemem macOS lub Linux, możesz użyć jednej z tych opcji:

Logowanie się i testowanie interfejsu wiersza poleceń Firebase

Po zainstalowaniu interfejsu wiersza poleceń musisz się uwierzytelnić. Następnie możesz potwierdzić uwierzytelnianie, podając listę projektów Firebase.

1. Zaloguj się w Firebase za pomocą konta Google, uruchamiając to polecenie:

   firebase login

   To polecenie połączy Twój komputer lokalny z Firebase i przyzna Ci dostęp do projektów Firebase.

2. Sprawdź, czy wiersz poleceń jest prawidłowo zainstalowany i czy ma dostęp do Twojego konta, wyświetlając listę projektów Firebase. Uruchom to polecenie:

   firebase projects:list

   Wyświetlona lista powinna być taka sama jak projektów Firebase wymienionych w konsolę Firebase.

Aktualizowanie do najnowszej wersji interfejsu wiersza poleceń

Zazwyczaj warto korzystać z najnowszej wersji interfejsu wiersza poleceń Firebase.

Sposób aktualizacji wersji interfejsu wiersza poleceń zależy od systemu operacyjnego i sposobu zainstalowania interfejsu wiersza poleceń.

Korzystanie z interfejsu wiersza poleceń w systemach CI

Narzędzie wiersza poleceń Firebase wymaga przeglądarki do uwierzytelnienia, ale jest w pełni zgodne z CI i innymi środowiskami bez głowy.

1. Na komputerze z przeglądarką zainstaluj interfejs wiersza poleceń Firebase.

2. Rozpocznij proces logowania, uruchamiając następujące polecenie:

   firebase login:ci

3. Otwórz podany adres URL i zaloguj się na konto Google.

4. Wydrukuj nowy dokument token odświeżania. Nie będzie to miało wpływu na bieżącą sesję interfejsu wiersza poleceń.

5. Przechowuj token wyjściowy w bezpieczny, ale dostępny sposób w systemie CI.

6. Użyj tego tokena podczas wykonywania poleceń firebase. Możesz użyć dowolnej z tych metod następujące dwie opcje:

   • Opcja 1. Zapisywanie tokena jako zmiennej środowiskowej FIREBASE_TOKEN System automatycznie użyje tokena.

   • Opcja 2: uruchom wszystkie polecenia firebase z flagą --token TOKEN w systemie CI.
     Oto kolejność wczytywania tokenów: flaga, środowisko wybranego projektu Firebase.

Inicjowanie projektu Firebase

Wiele typowych zadań wykonywanych za pomocą wiersza poleceń, takich jak wdrażanie w projekcie Firebase, wymaga katalogu projektu. Utwórz katalog projektu za pomocą polecenia firebase init. Katalog projektu jest zwykle taki sam jako katalog główny źródła, a po uruchomieniu polecenia firebase init katalog zawiera konfigurację firebase.json .

Aby zainicjować nowy projekt Firebase, uruchom następujące polecenie na swoim katalogu aplikacji:

firebase init

Polecenie firebase init przeprowadzi Cię przez proces konfigurowania katalogu projektu i niektóre usługi Firebase. Podczas inicjowania projektu interfejs wiersza poleceń Firebase prosi o wykonanie tych czynności:

• Wybierz usługi Firebase, które chcesz skonfigurować w projekcie Firebase.

  W tym kroku pojawi się prośba o ustawienie konfiguracji dla konkretnych plików na potrzeby platformy wybrane produkty. Więcej informacji o tych konfiguracjach znajdziesz w dokumentacji konkretnego produktu (np. Hosting). Pamiętaj, że zawsze możesz uruchomić polecenie firebase init, aby skonfigurować więcej usług Firebase.

• Wybierz domyślny projekt Firebase.

  Ten krok powiąże bieżący katalog projektu z projektem Firebase, które polecenia specyficzne dla projektu (takie jak firebase deploy) są uruchamiane w odniesieniu do dla odpowiedniego projektu Firebase.

  Możesz też powiązać wiele projektów Firebase (np. projekt testowy i produkcyjny) z tą samą katalogiem projektu.

Pod koniec inicjalizacji Firebase automatycznie tworzy w katalogu głównym lokalnej aplikacji te 2 pliki:

• Plik konfiguracji firebase.json, który zawiera konfigurację projektu.

• Plik .firebaserc, w którym są przechowywane aliasy projektu.

plik firebase.json;

Polecenie firebase init tworzy firebase.json plik konfiguracji w katalogu głównym projektu.

Plik firebase.json jest wymagany do wdrażać zasoby za pomocą interfejsu wiersza poleceń Firebase, ponieważ określa on: które pliki i ustawienia z katalogu projektu są wdrożone projekt Firebase. Ponieważ niektóre ustawienia mogą być zdefiniowane w katalogu projektu lub konsoli Firebase, upewnij się, że rozwiązujesz wszelkie potencjalne konflikty wdrożenia.

Możesz skonfigurować większość opcji usługi Firebase Hosting bezpośrednio w pliku firebase.json. W przypadku innych usług Firebase, które można wdrożyć za pomocą interfejsu wiersza poleceń Firebase, polecenie firebase init tworzy określone pliki, w których możesz zdefiniować ustawienia tych usług, np. plik index.js dla usługi Cloud Functions. W pliku firebase.json możesz też skonfigurować haczyki przed wdrożeniem lub po wdrożeniu.

Poniżej znajduje się przykładowy plik firebase.json z ustawieniami domyślnymi, jeśli: wybierz Firebase Hosting, Cloud Firestore i Cloud Functions for Firebase (z wybranymi opcjami źródła i lintowania TypeScript) podczas inicjowania.

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

Domyślnie używany jest plik firebase.json, ale możesz podać flagę --config PATH, aby określić inny plik konfiguracji.

Konfiguracja wielu baz danych Cloud Firestore

Gdy uruchomisz firebase init, plik firebase.json będzie zawierać jeden klucz firestore odpowiadający domyślnej bazie danych projektu, jak pokazano powyżej.

Jeśli Twój projekt zawiera wiele baz danych Cloud Firestore, zmodyfikuj plik firebase.json, aby powiązać z każdą z nich różne pliki źródłowe indeksu Cloud Firestore Security Rules i bazy danych. Zmodyfikuj plik za pomocą tablicy JSON z pojedynczym wpisem dla każdej bazy danych.

      "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 plików, które mają być ignorowane podczas wdrażania

Podczas wdrażania funkcji interfejs wiersza poleceń automatycznie określa listę plików w katalogu functions, które należy zignorować. Zapobiega to wdrażaniu na zapleczu niepotrzebnych plików, które mogłyby zwiększyć rozmiar wdrożenia.

Domyślnie ignorowana lista plików w formacie JSON:

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

Jeśli dodasz własne wartości niestandardowe dla elementu ignore w elementach firebase.json, pamiętaj, aby zachować (lub dodać, jeśli brakuje) listę plików pokazaną powyżej.

Zarządzanie aliasami projektu

Z tym samym katalogiem projektów możesz powiązać wiele projektów Firebase. Możesz na przykład używać jednego projektu Firebase do testów, a drugiego do wersji produkcyjnej. Korzystając z różnych środowisk projektów, możesz weryfikować zmiany przed wdrożeniem ich w produkcji. Polecenie firebase use umożliwia przełączanie się między aliasami oraz tworzenie nowych aliasów.

Dodaj alias projektu

Gdy wybierzesz projekt Firebase podczas inicjalizacji projektu, zostanie mu automatycznie przypisany alias default. Aby jednak zezwalać na uruchamianie poleceń dotyczących konkretnego projektu w ramach innego projektu Firebase, ale nadal używać tego samego katalogu projektu, uruchom to polecenie w katalogu projektu:

firebase use --add

To polecenie spowoduje wyświetlenie prompta z prośbą o wybranie innego projektu Firebase i przypisanie mu aliasu. Przypisania aliasów są zapisywane w pliku .firebaserc wewnątrz katalogu projektu.

Używanie aliasów projektów

Aby używać przypisanych aliasów projektu Firebase, uruchom dowolne z tych poleceń w sekcji: w katalogu projektu.

Możesz zmienić projekt używany jako aktywny, podając flagę --project w dowolnym poleceniu wiersza poleceń. Na przykład możesz skonfigurować interfejs wiersza poleceń tak, aby działał w projektie Firebase, do którego przypisałeś alias staging. Jeśli chcesz wykonać pojedyncze polecenie w projekcie Firebase, do którego przypisałeś alias prod, możesz użyć np. polecenia firebase deploy --project=prod.

Kontrola wersji i aliasy projektów

Ogólnie rzecz biorąc, sprawdź plik .firebaserc w kontroli źródła, aby aby zespół mógł udostępniać aliasy projektów. Jednak w przypadku projektów open source lub szablonów startowych nie należy zazwyczaj sprawdzać pliku .firebaserc.

Jeśli masz projekt deweloperski, który jest przeznaczony tylko do Ciebie, możesz: flagę --project przy każdym poleceniu lub uruchomieniu firebase use PROJECT_ID bez przypisywania aliasu do domeny w projekcie Firebase.

Udostępnianie i testowanie projektu Firebase lokalnie

Możesz wyświetlić i przetestować projekt Firebase pod lokalnymi adresami URL wdrażanie w środowisku produkcyjnym. Jeśli chcesz przetestować tylko wybrane funkcje, możesz użyć listy oddzielonych przecinkami w flagach w komendzie firebase serve.

Jeśli chcesz wykonać jedną z tych czynności, uruchom to polecenie w głównym katalogu projektu lokalnego:

• Wyświetlanie treści statycznych aplikacji hostowanej w Firebase.
• Używasz Cloud Functions do generowania dynamicznych treści dla Firebase Hosting i chcesz użyć funkcji HTTP w wersji produkcyjnej (wdrożonej), aby emulować Hosting w lokalnym adresie URL.

firebase serve --only hosting

Emulowanie projektu za pomocą lokalnych funkcji HTTP

Uruchom dowolne z tych poleceń z katalogu projektu, aby emulować za pomocą lokalnych funkcji HTTP.

• Aby emulować funkcje HTTP i hosting na potrzeby testowania adresów URL lokalnych, użyj jednego z tych poleceń:

  firebase serve

  firebase serve --only functions,hosting // uses a flag

• Aby emulować tylko funkcje HTTP, użyj tego polecenia:

  firebase serve --only functions

Testowanie na innych urządzeniach lokalnych

Domyślnie firebase serve odpowiada tylko na prośby, które wysyła localhost. Ten Oznacza to, że dostęp do hostowanych treści będzie możliwy przez internet na komputerze. z przeglądarki, ale nie z innych urządzeń w sieci. Jeśli chcesz prowadzić testy na innych urządzeniach lokalnych, użyj flagi --host w ten sposób:

firebase serve --host 0.0.0.0  // accepts requests to any host

Wdrażanie w projekcie Firebase

Interfejs wiersza poleceń Firebase zarządza wdrażaniem kodu i zasobów w Firebase projektu, w tym:

• nowe wersje witryn Firebase Hosting,
• Nowe, zaktualizowane lub istniejące Cloud Functions for Firebase
• Nowe lub zaktualizowane schematy i oprogramowanie sprzęgające dla: Firebase Data Connect
• Reguły dotyczące domeny Firebase Realtime Database
• Reguły dotyczące domeny Cloud Storage for Firebase
• Reguły dotyczące Cloud Firestore
• Indeksy dla zadania Cloud Firestore

Aby wdrożyć projekt w Firebase, uruchom to polecenie w katalogu projektu:

firebase deploy

Do każdego wdrożenia możesz opcjonalnie dodać komentarz. Ten komentarz będzie wraz z innymi informacjami o wdrożeniu w Firebase Hosting Przykład:

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

Podczas korzystania z polecenia firebase deploy pamiętaj o tych uwagach:

• Aby wdrożyć zasoby z katalogu projektu, katalog ten musi zawierać plik firebase.json. Ten plik jest utworzony automatycznie przez firebase init.

• Domyślnie firebase deploy tworzy wersję wszystkich zasobów do wdrożenia w katalogu projektu. Aby wdrożyć określone usługi lub funkcje Firebase: skorzystaj z częściowego wdrożenia.

Konflikty wdrażania reguł zabezpieczeń

W przypadku usług Firebase Realtime Database, Cloud Storage for Firebase i Cloud Firestore: możesz zdefiniować reguły zabezpieczeń w lokalnym katalogu projektu albo Firebase konsola.

Innym sposobem uniknięcia konfliktów wdrożenia jest użyj częściowego wdrożenia i zdefiniuj reguły tylko w sekcji konsoli Firebase.

Limity wdrożeń

Możliwe (choć mało prawdopodobne), że przekroczysz limit, który ogranicza szybkość lub liczbę operacji wdrażania Firebase. Na przykład podczas wdrażania bardzo dużej liczby funkcji możesz otrzymać komunikat o błędzie HTTP 429 Quota. Aby rozwiązać takie problemy, spróbuj wykorzystać częściowe wdrożenie.

Wycofywanie wdrożenia

Możesz cofnąć wdrożenie Firebase Hosting na stronie Firebase Hosting projektu, wybierając działanie Cofnij dla wybranej wersji.

Obecnie nie można wycofywać wersji reguł zabezpieczeń w przypadku Firebase Realtime Database, Cloud Storage for Firebase lub Cloud Firestore

Wdrażanie konkretnych usług Firebase

Jeśli chcesz wdrożyć tylko określone usługi lub funkcje Firebase, możesz użyć oddzielona przecinkami we fladze w poleceniu firebase deploy. Przykład: to polecenie wdrożyło treść Firebase Hosting i Cloud Storage reguły zabezpieczeń.

firebase deploy --only hosting,storage

W tabeli poniżej znajdziesz usługi i funkcje dostępne w przypadku lub wdrożenia. Nazwy w flagach odpowiadają kluczom w firebase.json.

Wdrażanie określonych funkcji

Podczas wdrażania funkcji możesz kierować reklamy na określone funkcje. Przykład:

firebase deploy --only functions:function1

firebase deploy --only functions:function1,functions:function2

Inną opcją jest pogrupowanie funkcji w grupy eksportu w /functions/index.js. Funkcja grupowania umożliwia wdrażanie wielu funkcji za pomocą jednego polecenia.

Aby zdefiniować groupA i groupB, możesz na przykład użyć tych funkcji:

var functions = require('firebase-functions/v1');

exports.groupA = {
  function1: functions.https.onRequest(...),
  function2: functions.database.ref('\path').onWrite(...)
}
exports.groupB = require('./groupB');

W tym przykładzie oddzielny plik functions/groupB.js zawiera dodatkowe które dokładnie definiują funkcje w funkcji groupB. Przykład:

var functions = require('firebase-functions/v1');

exports.function3 = functions.storage.object().onChange(...);
exports.function4 = functions.analytics.event('in_app_purchase').onLog(...);

W tym przykładzie możesz wdrożyć wszystkie funkcje groupA, uruchamiając to polecenie w katalogu projektu:

firebase deploy --only functions:groupA

Możesz też ukierunkować funkcję na określony element w grupie, uruchamiając to polecenie:

firebase deploy --only functions:groupA.function1,groupB.function4

Usuwanie funkcji

Wiersz poleceń Firebase obsługuje te polecenia i opcje umożliwiające usuwanie wcześniej wdrożonych funkcji:

• Usuwa wszystkie funkcje, które pasują do określonej nazwy we wszystkich regionach:

  firebase functions:delete FUNCTION-1_NAME

• Usuwa określoną funkcję działającą w regionie innym niż domyślny:

  firebase functions:delete FUNCTION-1_NAME --region REGION_NAME

• Usuwa więcej niż 1 funkcję:

  firebase functions:delete FUNCTION-1_NAME FUNCTION-2_NAME

• Usuwa określoną grupę funkcji:

  firebase functions:delete GROUP_NAME

• Pomija prośbę o potwierdzenie:

  firebase functions:delete FUNCTION-1_NAME --force

Konfigurowanie zadań skryptów wykonywanych przed wdrożeniem i po wdrożeniu

Możesz połączyć skrypty powłoki z poleceniem firebase deploy, aby wykonać działanie zadań przed wdrożeniem lub po wdrożeniu. Na przykład skrypt przed wdrożeniem może przetłumaczyć kod TypeScript na JavaScript, a element wywoływania po wdrożeniu może powiadomić administratorów o nowym wdrożeniu treści witryny do Firebase Hosting.

Aby skonfigurować uchwyty przed wdrożeniem lub po wdrożeniu, dodaj skrypty bash do pliku konfiguracyjnego firebase.json. Scenariusze krótkich tekstów możesz definiować bezpośrednio w pliku firebase.json lub odwoływać się do innych plików w katalogu projektu.

Na przykład ten skrypt to wyrażenie firebase.json dla zadania wykonywanego po wdrożeniu, które wysyła wiadomość do Slacka po pomyślnym wdrożeniu do Firebase Hosting.

"hosting": {
  // ...

  "postdeploy": "./messageSlack.sh 'Just deployed to Firebase Hosting'",
  "public": "public"
}

Plik skryptu messageSlack.sh znajduje się w katalogu projektu i wygląda podobny do tego:

curl -X POST -H 'Content-type: application/json' --data '{"text":"$1"}'
     \https://SLACK_WEBHOOK_URL

Możesz skonfigurować predeploy i postdeploy dla wszystkich zasobów, które możesz wdrożyć. Pamiętaj, że uruchomienie pliku firebase deploy uruchamia wszystkie zadania przed wdrożeniem i po jego zakończeniu zdefiniowane w pliku firebase.json. Aby uruchomić tylko zadania powiązane z konkretną usługą Firebase, użyj poleceń częściowego wdrożenia.

Zarówno predeploy, jak i postdeploy wyświetlają w terminalu standardowe dane wyjściowe i strumień błędów skryptów. W przypadku niepowodzenia:

• Jeśli nie uda się uruchomić przedwdrożeniowego haka zgodnie z oczekiwaniami, wdrożenie zostanie anulowane.
• Jeśli wdrożenie nie powiedzie się z jakiegoś powodu, punkty zaczepienia po wdrożeniu nie zostaną aktywowane.

Zmienne środowiskowe

W skryptach działających w punktach zaczepienia przed wdrożeniem i po wdrożeniu: zmienne środowiskowe są dostępne:

• $GCLOUD_PROJECT: identyfikator aktywnego projektu.
• $PROJECT_DIR: katalog główny zawierający plik firebase.json.
• $RESOURCE_DIR: (tylko w przypadku skryptów hosting i functions) jest lokalizacja katalogu, w którym znajduje się Hosting lub Zasoby do wdrożenia: Cloud Functions

Zarządzaj wieloma instancjami Realtime Database

Projekt Firebase może mieć wiele instancji Firebase Realtime Database. Według domyślnie polecenia interfejsu wiersza poleceń współdziałają z domyślną instancją bazy danych.

Możesz jednak wchodzić w interakcje z niedomyślnym wystąpieniem bazy danych, używając flagi --instance DATABASE_NAME. te polecenia obsługują flagę --instance:

• firebase database:get
• firebase database:profile
• firebase database:push
• firebase database:remove
• firebase database:set
• firebase database:update

Dokumentacja polecenia

Polecenia administracyjne w interfejsie wiersza poleceń

Polecenia zarządzania projektem

Wdrażanie i programowanie lokalne

Te polecenia pozwalają wdrożyć witrynę Firebase Hosting i korzystać z niej.

Polecenia App Distribution

App Hosting poleceń

Polecenia Authentication (zarządzanie użytkownikami)

Polecenia Cloud Firestore

Cloud Functions for Firebase poleceń

Więcej informacji zawiera artykuł na temat środowiska dokumentacji konfiguracji.

Polecenia Crashlytics

Polecenia Data Connect

Te polecenia i ich zastosowania są opisane bardziej szczegółowo w Data Connectprzewodniku po interfejsie wiersza poleceń.

Extensions poleceń

Extensions polecenia wydawcy

Polecenia Hosting

Polecenia Realtime Database

Pamiętaj, że możesz utworzyć początkową, domyślną instancję Realtime Database w konsoli Firebase lub za pomocą ogólnego firebase initprzepływu pracy lub konkretnego firebase init databaseprzepływu.

Po utworzeniu instancji możesz nimi zarządzać zgodnie z opisem w artykule Zarządzaj wieloma instancjami Realtime Database.

Remote Config poleceń