Firebase CLI-Referenz

Die Firebase CLI (GitHub) bietet eine Vielzahl von Tools zum Verwalten, Ansehen und Bereitstellen in Firebase-Projekten.

Bevor Sie die Firebase-Befehlszeile verwenden, ein Firebase-Projekt einrichten

Befehlszeile einrichten oder aktualisieren

Firebase CLI installieren

Sie können die Firebase-Befehlszeile mit einer Methode installieren, die Ihrem Betriebssystem entspricht Erfahrungsniveau und/oder Anwendungsfall. Unabhängig davon, wie Sie die Befehlszeile installieren, haben Sie Zugriff auf dieselben Funktionen und den Befehl firebase.

Windows macOS Linux

Windows

Sie können die Firebase-Befehlszeile für Windows mit einer der folgenden Methoden installieren Optionen:

macOS oder Linux

Sie können die Firebase-Befehlszeile für macOS oder Linux mit einer der folgende Optionen:

Anmelden und die Firebase-Befehlszeile testen

Nach der Installation der Befehlszeile müssen Sie sich authentifizieren. Anschließend können Sie die Authentifizierung bestätigen, indem Sie Ihre Firebase-Projekte auflisten.

1. Melden Sie sich mit Ihrem Google-Konto in Firebase an, indem Sie Folgendes ausführen: Befehl:

   firebase login

   Dieser Befehl verbindet Ihren lokalen Computer mit Firebase und gewährt Ihnen auf Ihre Firebase-Projekte zugreifen können.

2. Testen Sie, ob die Befehlszeile richtig installiert ist und auf Ihr Konto zugreifen kann, indem Sie Ihre Firebase-Projekte auflisten. Führen Sie dazu diesen Befehl aus:

   firebase projects:list

   Die angezeigte Liste sollte mit den Firebase-Projekten in der Firebase Console übereinstimmen.

Auf die neueste Befehlszeilenversion aktualisieren

Im Allgemeinen sollten Sie die aktuelle Version der Firebase-Befehlszeile verwenden.

Wie Sie die Befehlszeilenversion aktualisieren, hängt von Ihrem Betriebssystem und davon ab, wie Sie die Befehlszeile installiert.

Befehlszeile mit CI-Systemen verwenden

Für die Firebase-Befehlszeile ist ein Browser erforderlich, um die Authentifizierung abzuschließen. Die Befehlszeile ist jedoch vollständig mit CI und anderen headless-Umgebungen kompatibel.

1. Installieren Sie die Firebase CLI auf einem Computer mit einem Browser.

2. Starten Sie den Anmeldeprozess, indem Sie den folgenden Befehl ausführen:

   firebase login:ci

3. Rufen Sie die angegebene URL auf und melden Sie sich mit einem Google-Konto an.

4. Drucken Sie ein neues Aktualisierungstoken aus. Die aktuelle Befehlszeilensitzung ist davon nicht betroffen.

5. Speichern Sie das Ausgabetoken auf sichere, aber zugängliche Weise in Ihrem CI-System.

6. Verwenden Sie dieses Token, wenn Sie firebase-Befehle ausführen. Sie können eine der folgende zwei Optionen:

   • Option 1: Token als Umgebungsvariable speichern FIREBASE_TOKEN Das Token wird automatisch von Ihrem System verwendet.

   • Option 2: Führen Sie alle firebase-Befehle mit dem Flag --token TOKEN in Ihrem CI-System aus.
     Dies ist die Rangfolge beim Laden von Tokens: Flag, Umgebung Variable, gewünschtes Firebase-Projekt.

Firebase-Projekt initialisieren

Viele gängige Aufgaben, die mit der Befehlszeile ausgeführt werden, wie die Bereitstellung in einem Firebase-Projekt, erfordern ein Projektverzeichnis. Sie erstellen ein Projektverzeichnis mit dem Befehl firebase init. Ein Projektverzeichnis ist normalerweise dasselbe als Stammverzeichnis der Versionsverwaltung. Nach der Ausführung von firebase init wird der Verzeichnis eine firebase.json-Konfiguration enthält -Datei.

Führen Sie zum Initialisieren eines neuen Firebase-Projekts den folgenden Befehl im Verzeichnis Ihrer App aus:

firebase init

Mit dem Befehl firebase init werden Sie durch die Einrichtung Ihres Projektverzeichnisses und einiger Firebase-Produkte geführt. Während der Projektinitialisierung werden Sie von der Firebase-Befehlszeile aufgefordert, die folgenden Aufgaben auszuführen:

• Wählen Sie die gewünschten Firebase-Produkte aus, die Sie in Ihrem Firebase-Projekt einrichten möchten.

  In diesem Schritt werden Sie aufgefordert, Konfigurationen für bestimmte Dateien ausgewählten Produkten. Weitere Informationen zu diesen Konfigurationen finden Sie in der in der Dokumentation des jeweiligen Produkts (z. B. Hosting) Beachten Sie, dass Sie kann firebase init später ausführen, um weitere Firebase-Produkte einzurichten.

• Wählen Sie ein Firebase-Standardprojekt aus.

  In diesem Schritt wird das aktuelle Projektverzeichnis mit einem Firebase-Projekt verknüpft, damit projektspezifische Befehle (z. B. firebase deploy) für das entsprechende Firebase-Projekt ausgeführt werden.

  Es ist auch möglich, mehrere Firebase-Projekte verknüpfen (z. B. ein Staging-Projekt und ein Produktionsprojekt) mit demselben Projekt -Verzeichnis.

Am Ende der Initialisierung erstellt Firebase automatisch die folgenden beiden Dateien im Stammverzeichnis Ihres lokalen App-Verzeichnisses:

• Eine firebase.json-Konfigurationsdatei, in der Ihre Projektkonfiguration.

• Eine .firebaserc-Datei, in der die Aliasse Ihres Projekts gespeichert sind.

Datei firebase.json

Mit dem Befehl firebase init wird im Stammverzeichnis des Projektverzeichnisses eine firebase.json-Konfigurationsdatei erstellt.

Die Datei firebase.json ist erforderlich, um Assets mit der Firebase-Befehlszeile bereitstellen, da sie Folgendes angibt: welche Dateien und Einstellungen aus Ihrem Projektverzeichnis auf Ihrem Firebase-Projekt Da einige Einstellungen in Ihrem Projekt definiert werden können, oder im Firebase-Konsole, beheben Sie alle möglichen Probleme, Bereitstellungskonflikte.

Sie können die meisten Firebase Hosting-Optionen direkt in der Datei firebase.json konfigurieren. Bei anderen Firebase-Diensten, die mit der Firebase CLI bereitgestellt werden können, werden mit dem Befehl firebase init jedoch bestimmte Dateien erstellt, in denen Sie Einstellungen für diese Dienste definieren können, z. B. eine index.js-Datei für Cloud Functions. Sie können auch Pre-Deploy- oder Post-Deploy-Hooks in der Datei firebase.json einrichten.

Im Folgenden finden Sie ein Beispiel für eine firebase.json-Datei mit den Standardeinstellungen, wenn Sie bei der Initialisierung Firebase Hosting, Cloud Firestore und Cloud Functions for Firebase (mit ausgewählten TypeScript-Quell- und Lint-Optionen) auswählen.

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

Standardmäßig wird firebase.json verwendet. Sie können das Flag --config PATH übergeben, um eine alternative Konfigurationsdatei anzugeben.

Konfiguration für mehrere Cloud Firestore-Datenbanken

Wenn Sie firebase init ausführen, enthält die Datei firebase.json ein einzelnes firestore-Schlüssel entsprechend der Standarddatenbank Ihres Projekts, wie gezeigt oben.

Wenn Ihr Projekt mehrere Cloud Firestore-Datenbanken enthält, bearbeiten Sie die firebase.json-Datei, um verschiedene Cloud Firestore Security Rules- und Quelldateien des Datenbankindex mit jeder Datenbank. Ändern Sie die Datei in ein JSON-Array mit einem Eintrag pro Datenbank.

      "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 Dateien, die beim Bereitstellen ignoriert werden sollen

Bei der Bereitstellung der Funktion gibt die Befehlszeile automatisch eine Liste der Dateien im Verzeichnis functions an, die ignoriert werden sollen. So wird verhindert, dass überflüssige Dateien im Backend bereitgestellt werden, die die Datengröße Ihrer Bereitstellung erhöhen könnten.

Die Liste der standardmäßig ignorierten Dateien im JSON-Format sieht so aus:

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

Wenn Sie eigene benutzerdefinierte Werte für ignore in firebase.json hinzufügen, bewahren Sie die oben aufgeführte Liste der Dateien auf oder fügen Sie sie hinzu, falls sie fehlt.

Projektaliasse verwalten

Sie können mehrere Firebase-Projekte mit demselben Projektverzeichnis verknüpfen. Beispielsweise können Sie ein Firebase-Projekt für das Staging und ein anderes verwenden. für die Produktion. Durch die Verwendung verschiedener Projektumgebungen können Sie Änderungen überprüfen bevor sie in der Produktion bereitgestellt werden. Mit dem Befehl firebase use können Sie zwischen Aliassen und das Erstellen neuer Aliasse.

Projektalias hinzufügen

Wenn Sie bei der Projektinitialisierung ein Firebase-Projekt auswählen, wird dem Projekt automatisch der Alias default zugewiesen. Um jedoch projektspezifischen Befehlen für ein anderes Firebase-Projekt ausgeführt, aber dennoch dasselbe Projekt verwenden führen Sie in Ihrem Projektverzeichnis den folgenden Befehl aus:

firebase use --add

Sie werden aufgefordert, ein anderes Firebase-Projekt auszuwählen und ihm einen Alias zuzuweisen. Aliaszuweisungen werden in eine .firebaserc-Datei im Projektverzeichnis geschrieben.

Projektaliasse verwenden

Führen Sie einen der folgenden Befehle aus, um zugewiesene Firebase-Projektaliasse zu verwenden: in Ihrem Projektverzeichnis.

Sie können überschreiben, was als derzeit aktives Projekt verwendet wird, indem Sie das Flag --project mit einem beliebigen Befehl über die Befehlszeile eingeben. Beispiel: Sie können die Befehlszeile so einrichten, dass sie für ein Firebase-Projekt ausgeführt wird, dem Sie den Alias staging zugewiesen haben. Wenn Sie einen einzelnen Befehl für das Firebase-Projekt ausführen möchten, dem Sie den Alias prod zugewiesen haben, können Sie beispielsweise firebase deploy --project=prod ausführen.

Versionsverwaltung und Projektaliasse

Im Allgemeinen sollten Sie Ihre .firebaserc-Datei in die Versionskontrolle einchecken, damit Ihr Team Projektaliasse freigeben kann. Bei Open-Source-Projekten oder Startervorlagen sollten Sie Ihre .firebaserc-Datei jedoch im Allgemeinen nicht einchecken.

Wenn Sie ein Entwicklungsprojekt haben, das nur für Sie bestimmt ist, können Sie entweder das Flag --project mit jedem Befehl übergeben oder firebase use PROJECT_ID ausführen, ohne dem Firebase-Projekt einen Alias zuzuweisen.

Firebase-Projekt lokal bereitstellen und testen

Sie können Ihr Firebase-Projekt auf lokal gehosteten URLs ansehen und testen, für die Produktion bereitstellen. Wenn Sie nur ausgewählte Funktionen testen möchten, können Sie eine durch Kommas getrennte Liste in einem Flag für den Befehl firebase serve verwenden.

Führen Sie den folgenden Befehl im Stammverzeichnis Ihres lokalen Projektverzeichnisses aus, wenn Sie eine der folgenden Aufgaben ausführen möchten:

• Sehen Sie sich den statischen Inhalt Ihrer von Firebase gehosteten App an.
• Verwenden Sie Cloud Functions, um dynamische Inhalte für Firebase Hosting und Sie möchten Ihr HTTP-Funktionen für die Produktion (bereitgestellt), um Hosting auf einer lokalen URL zu emulieren.

firebase serve --only hosting

Projekt mit lokalen HTTP-Funktionen emulieren

Führen Sie einen der folgenden Befehle in Ihrem Projektverzeichnis aus, um die mithilfe von lokalen HTTP-Funktionen erstellen.

• Um HTTP-Funktionen und das Hosting für Tests auf lokalen URLs zu emulieren, verwenden Sie entweder der folgenden Befehle:

  firebase serve

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

• Wenn Sie nur HTTP-Funktionen emulieren möchten, verwenden Sie den folgenden Befehl:

  firebase serve --only functions

Testen von anderen lokalen Geräten

Standardmäßig antwortet firebase serve nur auf Anfragen von localhost. Dieses bedeutet, dass Sie über das Web auf Ihrem Computer auf Ihre gehosteten Inhalte zugreifen können. Browser, aber nicht von anderen Geräten in Ihrem Netzwerk. Wenn Sie von verschiedenen anderen lokalen Geräten verwenden, verwenden Sie das Flag --host so:

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

In einem Firebase-Projekt bereitstellen

Über die Firebase-Befehlszeile wird die Bereitstellung von Code und Assets in Firebase verwaltet. Projekt umfassen:

• Neue Versionen Ihrer Firebase Hosting Websites
• Neue, aktualisierte oder vorhandene Cloud Functions for Firebase
• Neue oder aktualisierte Schemas und Konnektoren für Firebase Data Connect
• Regeln für Firebase Realtime Database
• Regeln für Cloud Storage for Firebase
• Regeln für Cloud Firestore
• Indexe für Cloud Firestore

Führen Sie den folgenden Befehl in Ihrem Projekt aus, um die Bereitstellung in einem Firebase-Projekt vorzunehmen Verzeichnis:

firebase deploy

Optional können Sie jeder Bereitstellung einen Kommentar hinzufügen. Dieser Kommentar wird zusammen mit den anderen Informationen zur Bereitstellung auf der Firebase Hosting-Seite Ihres Projekts angezeigt. Beispiel:

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

Beachten Sie Folgendes, wenn Sie den Befehl firebase deploy verwenden:

• Wenn Sie Ressourcen aus einem Projektverzeichnis bereitstellen möchten, muss das Projektverzeichnis eine firebase.json-Datei enthalten. Diese Datei wird automatisch durch den Befehl firebase init erstellt.

• Standardmäßig erstellt firebase deploy einen Release für alle bereitstellbaren Ressourcen in Ihrem Projektverzeichnis. Wenn Sie bestimmte Firebase-Dienste oder ‑Funktionen bereitstellen möchten, verwenden Sie die teilweise Bereitstellung.

Bereitstellungskonflikte bei Sicherheitsregeln

Für Firebase Realtime Database, Cloud Storage for Firebase und Cloud Firestore: können Sie Sicherheitsregeln entweder in Ihrem lokalen Projektverzeichnis oder in der Firebase-Konsole.

Eine weitere Möglichkeit, Bereitstellungskonflikte zu vermeiden, eine Teilbereitstellung verwenden und nur Regeln im Firebase-Konsole.

Bereitstellungskontingente

Es ist möglich, aber unwahrscheinlich, dass Sie ein Kontingent überschreiten, Volumen Ihrer Firebase-Bereitstellungsvorgänge. Wenn beispielsweise Wenn Sie sehr viele Funktionen bereitstellen, erhalten Sie möglicherweise die Fehlermeldung HTTP 429 Quota Fehlermeldung erhalten. Versuchen Sie, solche Probleme mithilfe der teilweisen Bereitstellung zu beheben.

Deployment rückgängig machen

Sie können eine Firebase Hosting-Bereitstellung auf der Firebase Hosting-Seite Ihres Projekts rückgängig machen, indem Sie für den gewünschten Release die Aktion Rollback auswählen.

Derzeit ist es nicht möglich, Releases von Sicherheitsregeln für Firebase Realtime Database, Cloud Storage for Firebase oder Cloud Firestore rückgängig zu machen.

Bestimmte Firebase-Dienste bereitstellen

Wenn Sie nur bestimmte Firebase-Dienste oder ‑Funktionen bereitstellen möchten, können Sie eine kommagetrennte Liste in einem Flag für den Befehl firebase deploy verwenden. Mit dem folgenden Befehl werden beispielsweise Firebase Hosting-Inhalte und Cloud Storage-Sicherheitsregeln bereitgestellt.

firebase deploy --only hosting,storage

In der folgenden Tabelle sind die Dienste und Funktionen aufgeführt, die für teilweise Bereitstellung. Die Namen in den Flags entsprechen den Schlüsseln in Ihrer Konfigurationsdatei firebase.json.

Bestimmte Funktionen bereitstellen

Beim Bereitstellen von Funktionen können Sie bestimmte Funktionen als Ziel angeben. Beispiel:

firebase deploy --only functions:function1

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

Eine weitere Möglichkeit besteht darin, Funktionen in Ihrer /functions/index.js-Datei in Exportgruppen zu gruppieren. Mit Gruppierungsfunktionen können Sie mehrere mit einem einzigen Befehl ausführen.

Sie können beispielsweise die folgenden Funktionen schreiben, um eine groupA und eine groupB zu definieren:

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

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

In diesem Beispiel enthält eine separate functions/groupB.js-Datei zusätzliche Funktionen, die die Funktionen in groupB speziell definieren. Beispiel:

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

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

In diesem Beispiel können Sie alle groupA-Funktionen bereitstellen, indem Sie den folgenden Befehl aus Ihrem Projektverzeichnis:

firebase deploy --only functions:groupA

Alternativ können Sie mit dem folgenden Befehl eine bestimmte Funktion innerhalb einer Gruppe anvisieren:

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

Funktionen löschen

Die Firebase-Befehlszeile unterstützt die folgenden Befehle und Optionen für Löschen zuvor bereitgestellter Funktionen:

• Hiermit werden alle Funktionen gelöscht, die in allen Regionen mit dem angegebenen Namen übereinstimmen:

  firebase functions:delete FUNCTION-1_NAME

• Löscht eine angegebene Funktion, die in einer anderen Region als der Standardregion ausgeführt wird:

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

• Löscht mehrere Funktionen:

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

• Löscht eine angegebene Funktionsgruppe:

  firebase functions:delete GROUP_NAME

• Umgeht die Bestätigungsaufforderung:

  firebase functions:delete FUNCTION-1_NAME --force

Script-Aufgaben vor und nach der Bereitstellung einrichten

Sie können Shell-Skripts mit dem Befehl firebase deploy verbinden, um Pre-Deploy- oder Nach-Deploy-Aufgaben zu tun. Ein Pre-Deploy-Script könnte beispielsweise TypeScript-Code in JavaScript transpilieren und ein Post-Deploy-Hook könnte Administratoren über das Bereitstellen neuer Websiteinhalte auf Firebase Hosting benachrichtigen.

Wenn Sie Pre-Deploy- oder Post-Deploy-Hooks einrichten möchten, fügen Sie Ihrer Konfigurationsdatei firebase.json Bash-Scripts hinzu. Sie können kurze Skripts direkt in der firebase.json-Datei erstellen oder auf andere die sich in Ihrem Projektverzeichnis befinden.

Das folgende Skript ist beispielsweise der Ausdruck firebase.json für eine Postdeploy-Aufgabe, die bei erfolgreicher Bereitstellung eine Slack-Nachricht an Firebase Hosting.

"hosting": {
  // ...

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

Die messageSlack.sh-Scriptdatei befindet sich im Projektverzeichnis und sieht so aus:

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

Sie können predeploy- und postdeploy-Hooks für alle Assets einrichten, die Sie bereitstellen können. Wenn Sie firebase deploy ausführen, löst alle Aufgaben aus, die in Ihrem firebase.json-Datei. Um nur die Aufgaben auszuführen, die mit einer bestimmten Firebase-Dienst verwenden Sie Befehle zur Teilbereitstellung.

Sowohl predeploy- als auch postdeploy-Hooks geben die Standardausgabe und die Fehlerstreams der Scripts im Terminal aus. Beachten Sie bei Fehlern Folgendes:

• Wenn ein Pre-Deploy-Hook nicht wie erwartet abgeschlossen wird, wird die Bereitstellung abgebrochen.
• Wenn die Bereitstellung aus irgendeinem Grund fehlschlägt, werden keine Post-Deployment-Hooks ausgelöst.

Umgebungsvariablen

In Skripts, die in den Hooks vor und nach der Bereitstellung ausgeführt werden, gilt Folgendes: Umgebungsvariablen verfügbar:

• $GCLOUD_PROJECT: Die Projekt-ID des aktiven Projekts
• $PROJECT_DIR: Das Stammverzeichnis, das die Datei firebase.json enthält
• $RESOURCE_DIR: (nur für hosting- und functions-Skripts) Die Speicherort des Verzeichnisses, das Hosting oder Cloud Functions zu implementierende Ressourcen

Mehrere Realtime Database-Instanzen verwalten

Ein Firebase-Projekt kann mehrere Firebase Realtime Database-Instanzen. Von CLI-Befehle interagieren mit Ihrer default-Datenbankinstanz.

Sie können jedoch mithilfe des Flags --instance DATABASE_NAME mit einer anderen Datenbankinstanz interagieren. Die Die folgenden Befehle unterstützen das Flag --instance:

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

Befehlsreferenz

Administrative CLI-Befehle

Befehle für das Projektmanagement

Bereitstellung und lokale Entwicklung

Mit diesen Befehlen können Sie Ihre Firebase Hosting-Website bereitstellen und damit interagieren.

App Distribution-Befehle

App Hosting-Befehle

Authentication-Befehle (Nutzerverwaltung)

Cloud Firestore-Befehle

Cloud Functions for Firebase-Befehle

Weitere Informationen findest du in der Umgebung Konfigurationsdokumentation.

Crashlytics-Befehle

Data Connect-Befehle

Diese Befehle und ihre Anwendungsfälle werden in der Referenzhandbuch zur Data Connect-Befehlszeile

Extensions-Befehle

Extensions Publisher-Befehle

Hosting-Befehle

Realtime Database-Befehle

Sie können Ihre anfängliche, standardmäßige Realtime Database-Instanz im Firebase oder über die allgemeine firebase init-Funktion oder die spezifische firebase init database-Ablauf.

Nachdem Instanzen erstellt wurden, können Sie sie wie in den Mehrere Realtime Database-Instanzen verwalten.

Remote Config-Befehle