Firebase CLI-Referenz

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

Bevor Sie die Firebase-Befehlszeile verwenden können, müssen Sie ein Firebase-Projekt einrichten.

Befehlszeile einrichten oder aktualisieren

Firebase CLI installieren

Sie können die Firebase CLI mit einer Methode installieren, die zu Ihrem Betriebssystem, Ihrem Erfahrungsstand und/oder Ihrem Anwendungsfall passt. 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 Optionen installieren:

macOS oder Linux

Sie können die Firebase CLI für macOS oder Linux mit einer der folgenden Optionen installieren:

Anmelden und die Firebase CLI 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. Führen Sie dazu den folgenden Befehl aus:

   firebase login

   Mit diesem Befehl wird Ihr lokaler Computer mit Firebase verbunden und Sie erhalten Zugriff auf Ihre Firebase-Projekte.

2. Prüfen Sie, ob die Befehlszeile richtig installiert ist und auf Ihr Konto zugreift, 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 CLI-Version aktualisieren

Im Allgemeinen sollten Sie die neueste Version der Firebase CLI verwenden.

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

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 Anmeldevorgang mit dem folgenden Befehl:

   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 haben zwei Möglichkeiten:

   • Option 1:Speichern Sie das Token als UmgebungsvariablenFIREBASE_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.
     Die Token-Ladereihenfolge: Flag, Umgebungsvariable, 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 in der Regel dasselbe Verzeichnis wie das Stammverzeichnis Ihrer Quellkontrolldatei. Nach dem Ausführen von firebase init enthält das Verzeichnis eine Konfigurationsdatei firebase.json.

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 für die ausgewählten Produkte festzulegen. Weitere Informationen zu diesen Konfigurationen finden Sie in der Dokumentation des jeweiligen Produkts, z. B. Hosting. Sie können firebase init auch später ausführen, um weitere Firebase-Produkte einzurichten.

• Wählen Sie ein Standard-Firebase-Projekt 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 (z. B. ein Staging- und ein Produktionsprojekt) mit demselben Projektverzeichnis zu verknüpfen.

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

• Eine firebase.json-Konfigurationsdatei mit Ihrer 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 firebase.json-Datei ist erforderlich, um Assets mit der Firebase-CLI bereitzustellen, da darin angegeben wird, welche Dateien und Einstellungen aus Ihrem Projektverzeichnis in Ihrem Firebase-Projekt bereitgestellt werden. Da einige Einstellungen entweder in Ihrem Projektverzeichnis oder in der Firebase-Konsole definiert werden können, müssen Sie alle potenziellen Bereitstellungskonflikte beheben.

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 jedoch 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 firebase.json-Datei einen einzelnen firestore-Schlüssel, der der Standarddatenbank Ihres Projekts entspricht, wie oben gezeigt.

Wenn Ihr Projekt mehrere Cloud Firestore-Datenbanken enthält, bearbeiten Sie die firebase.json-Datei, um jeder Datenbank unterschiedliche Cloud Firestore Security Rules- und Datenbankindex-Quelldateien zuzuordnen. Ä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:

"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. Sie können beispielsweise ein Firebase-Projekt für das Staging und ein anderes für die Produktion verwenden. Wenn Sie verschiedene Projektumgebungen verwenden, können Sie Änderungen prüfen, bevor Sie sie in der Produktionsumgebung bereitstellen. Mit dem Befehl firebase use können Sie zwischen Aliasen wechseln und neue Aliase erstellen.

Projektalias hinzufügen

Wenn Sie bei der Projektinitialisierung ein Firebase-Projekt auswählen, wird dem Projekt automatisch der Alias default zugewiesen. Wenn Sie jedoch möchten, dass projektspezifische Befehle für ein anderes Firebase-Projekt ausgeführt werden, aber weiterhin das gleiche Projektverzeichnis verwenden, führen Sie den folgenden Befehl aus dem Projektverzeichnis 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

Wenn Sie zugewiesene Aliasse für Firebase-Projekte verwenden möchten, führen Sie einen der folgenden Befehle in Ihrem Projektverzeichnis aus.

Sie können das derzeit aktive Projekt überschreiben, indem Sie das Flag --project mit einem beliebigen Befehl der Befehlszeile übergeben. Beispiel: Sie können die CLI 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.

Quellkontroll- 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, bevor Sie es in der 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:

• Statische Inhalte Ihrer Firebase-gehosteten App ansehen
• Sie verwenden Cloud Functions, um dynamische Inhalte für Firebase Hosting zu generieren, und möchten Ihre Produktions- (bereitgestellten) HTTP-Funktionen verwenden, um Hosting über eine lokale URL zu emulieren.

firebase serve --only hosting

Projekt mit lokalen HTTP-Funktionen emulieren

Führen Sie einen der folgenden Befehle aus Ihrem Projektverzeichnis aus, um Ihr Projekt mit lokalen HTTP-Funktionen zu emulieren.

• Verwenden Sie einen der folgenden Befehle, um HTTP-Funktionen und Hosting für Tests auf lokalen URLs zu emulieren:

  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

Test von anderen lokalen Geräten

Standardmäßig antwortet firebase serve nur auf Anfragen von localhost. Das bedeutet, dass Sie über den Webbrowser Ihres Computers auf Ihre gehosteten Inhalte zugreifen können, aber nicht über andere Geräte in Ihrem Netzwerk. Wenn Sie von anderen lokalen Geräten aus testen möchten, verwenden Sie das Flag --host, z. B. so:

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

In einem Firebase-Projekt bereitstellen

Mit der Firebase CLI können Sie Code und Assets in Ihrem Firebase-Projekt bereitstellen, darunter:

• 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 zum Bereitstellen in einem Firebase-Projekt den folgenden Befehl aus dem Projektverzeichnis aus:

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 eine Version für alle ausführbaren Ressourcen in Ihrem Projektverzeichnis. Wenn Sie bestimmte Firebase-Dienste oder ‑Funktionen bereitstellen möchten, verwenden Sie die teilweise Bereitstellung.

Bereitstellungskonflikte für 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 Console definieren.

Eine weitere Möglichkeit, Bereitstellungskonflikte zu vermeiden, besteht darin, eine teilweise Bereitstellung zu verwenden und nur Regeln in der Firebase-Konsole zu definieren.

Bereitstellungskontingente

Es ist möglich (wenn auch unwahrscheinlich), dass Sie ein Kontingent überschreiten, das die Häufigkeit oder das Volumen Ihrer Firebase-Bereitstellungsvorgänge begrenzt. Wenn Sie beispielsweise sehr viele Funktionen bereitstellen, erhalten Sie möglicherweise eine HTTP 429 Quota-Fehlermeldung. 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 eine teilweise Bereitstellung verfügbar sind. Die Namen in den Flags entsprechen den Schlüsseln in Ihrer Konfigurationsdatei firebase.json.

Bestimmte Funktionen bereitstellen

Beim Bereitstellen von Funktionen können Sie sie auf bestimmte Funktionen ausrichten. 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. Wenn Sie Funktionen gruppieren, können Sie mehrere Funktionen mit einem einzigen Befehl bereitstellen.

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 ausführen:

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 zum 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

• Mehrere Funktionen werden gelöscht:

  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-Scripts mit dem Befehl firebase deploy verknüpfen, um Aufgaben vor oder nach der Bereitstellung auszuführen. 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 Scripts direkt in der Datei firebase.json definieren oder auf andere Dateien im Projektverzeichnis verweisen.

Das folgende Script ist beispielsweise der firebase.json-Ausdruck für eine Aufgabe nach der Bereitstellung, die nach einer erfolgreichen Bereitstellung eine Slack-Nachricht an Firebase Hosting sendet.

"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, werden alle in der Datei firebase.json definierten Aufgaben vor und nach der Bereitstellung ausgelöst. Wenn Sie nur die Aufgaben ausführen möchten, die mit einem bestimmten Firebase-Dienst verknüpft sind, verwenden Sie Befehle für die teilweise Bereitstellung.

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 Scripts, die in den Pre-Deploy- und Post-Deploy-Hooks ausgeführt werden, sind die folgenden 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-Scripts) Der Speicherort des Verzeichnisses, das die bereitzustellenden Hosting- oder Cloud Functions-Ressourcen enthält

Mehrere Realtime Database-Instanzen verwalten

Ein Firebase-Projekt kann mehrere Firebase Realtime Database-Instanzen haben. Standardmäßig interagieren Befehlszeilenbefehle mit Ihrer Standarddatenbankinstanz.

Sie können jedoch mit einer anderen Datenbankinstanz interagieren, indem Sie das Flag --instance DATABASE_NAME verwenden. 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

Befehle für die Befehlszeile

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 finden Sie in der Dokumentation zur Umgebungskonfiguration.

Crashlytics-Befehle

Data Connect-Befehle

Diese Befehle und ihre Anwendungsfälle werden im Data Connect-Referenzhandbuch für die Befehlszeile ausführlicher behandelt.

Extensions-Befehle

Extensions Publisher-Befehle

Hosting-Befehle

Realtime Database-Befehle

Sie können Ihre erste Standard-Realtime Database-Instanz in der Firebase-Konsole oder mit dem allgemeinen firebase init-Workflow oder dem spezifischen firebase init database-Ablauf erstellen.

Nach dem Erstellen können Sie die Instanzen wie unter Mehrere Realtime Database-Instanzen verwalten beschrieben verwalten.

Remote Config-Befehle