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:

Option	Beschreibung	Empfohlen für…
Standalone-Binärdatei	Laden Sie die eigenständige Binärdatei für die Befehlszeile herunter. Anschließend können Sie auf die ausführbare Datei zugreifen, um eine Shell zu öffnen, in der Sie den Befehl firebase ausführen können.	Neue Entwickler Entwickler, die Node.js nicht verwenden oder nicht kennen
npm	Verwenden Sie npm (den Node Package Manager), um die Befehlszeile zu installieren und den global verfügbaren Befehl firebase zu aktivieren.	Entwickler, die Node.js verwenden

macOS oder Linux

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

Option	Beschreibung	Empfohlen für…
automatic install script	Führen Sie einen einzigen Befehl aus, der Ihr Betriebssystem automatisch erkennt, die neueste CLI-Version herunterlädt und dann den global verfügbaren Befehl firebase aktiviert.	Neue Entwickler Entwickler, die Node.js nicht verwenden oder nicht damit vertraut sind Automatisierte Bereitstellungen in einer CI/CD-Umgebung
Standalone-Binärdatei	Laden Sie die eigenständige Binärdatei für die Befehlszeile herunter. Anschließend können Sie das Binary entsprechend Ihrem Workflow konfigurieren und ausführen.	Vollständig anpassbare Workflows mit der Befehlszeile
npm	Verwenden Sie npm (den Node Package Manager), um die Befehlszeile zu installieren und den global verfügbaren Befehl firebase zu aktivieren.	Entwickler, die Node.js verwenden

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.

Befehl	Beschreibung
firebase use	Liste der derzeit definierten Aliasse für Ihr Projektverzeichnis aufrufen
firebase use \ PROJECT_ID|ALIAS	Alle Befehle werden für das angegebene Firebase-Projekt ausgeführt. Die Befehlszeile verwendet dieses Projekt als „aktuelles Projekt“.
firebase use --clear	Das aktive Projekt wird gelöscht. Führen Sie firebase use PROJECT_ID|ALIAS aus, um ein neues aktives Projekt festzulegen, bevor Sie andere Befehle in der Befehlszeile ausführen.
firebase use \ --unalias PROJECT_ALIAS	Entfernt einen Alias aus Ihrem Projektverzeichnis.

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.

Syntax für Flags	Dienst oder Funktion bereitgestellt
--only hosting	Inhalt auf Firebase Hosting
--only database	Firebase Realtime Database Regeln
--only dataconnect	Firebase Data Connect Schemas und Connectors
--only storage	Cloud Storage for Firebase Regeln
--only firestore	Cloud Firestore-Regeln und -Indexe für alle konfigurierten Datenbanken
--only functions	Cloud Functions for Firebase (spezifischere Versionen dieses Flags sind möglich)

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 löschen:

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

• Löscht eine angegebene Funktionsgruppe:

  firebase functions:delete GROUP_NAME

• Umgeht die Bestätigungsanfrage:

  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

Befehl	Beschreibung
help	Zeigt Hilfeinformationen zur Befehlszeile oder zu bestimmten Befehlen an.
init	Verknüpft und richtet ein neues Firebase-Projekt im aktuellen Verzeichnis ein. Mit diesem Befehl wird im aktuellen Verzeichnis eine Konfigurationsdatei firebase.json erstellt.
login	Authentifiziert die Befehlszeile bei Ihrem Firebase-Konto. Es ist der Zugriff auf einen Webbrowser erforderlich. Wenn Sie sich in Remote-Umgebungen, die keinen Zugriff auf localhost zulassen, in der Befehlszeile anmelden möchten, verwenden Sie das Flag --no-localhost.
login:ci	Generiert ein Authentifizierungstoken für die Verwendung in nicht interaktiven Umgebungen.
logout	Die CLI wird von Ihrem Firebase-Konto abgemeldet.
open	Öffnet einen Browser mit den relevanten Projektressourcen.
projects:list	Hier werden alle Firebase-Projekte aufgelistet, auf die Sie Zugriff haben.
verwenden	Hiermit wird das aktive Firebase-Projekt für die Befehlszeile festgelegt. Verwaltet Projektaliasse.

Befehle für das Projektmanagement

Befehl	Beschreibung
Verwaltung von Firebase-Projekten
projects:addfirebase	Fügen Sie einem vorhandenen Google Cloud-Projekt Firebase-Ressourcen hinzu.
projects:create	Es wird ein neues Google Cloud-Projekt erstellt und dem neuen Projekt werden dann Firebase-Ressourcen hinzugefügt.
projects:list	Hier werden alle Firebase-Projekte aufgelistet, auf die Sie Zugriff haben.
Verwaltung von Firebase-Apps (iOS, Android, Web)
apps:create	Erstellt eine neue Firebase-App im aktiven Projekt.
apps:list	Listet die registrierten Firebase-Apps im aktiven Projekt auf.
apps:sdkconfig	Gibt die Konfiguration der Google-Dienste einer Firebase-App aus.
setup:web	Eingestellt. Verwenden Sie stattdessen apps:sdkconfig und geben Sie web als Plattformargument an. Die Konfiguration der Google-Dienste einer Firebase-Webanwendung wird ausgegeben.
Verwaltung von SHA-Zertifikat-Hashes (nur Android)
apps:android:sha:create \ FIREBASE_APP_ID SHA_HASH	Fügt der angegebenen Firebase-Android-App den angegebenen SHA-Zertifikat-Hash hinzu.
apps:android:sha:delete \ FIREBASE_APP_ID SHA_HASH	Löscht den angegebenen SHA-Zertifikat-Hash aus der angegebenen Firebase-Android-App.
apps:android:sha:list \ FIREBASE_APP_ID	Listet die SHA-Zertifikat-Hashes für die angegebene Firebase-Android-App auf.

Bereitstellung und lokale Entwicklung

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

Befehl	Beschreibung
deploy	Hiermit werden Code und Assets aus Ihrem Projektverzeichnis in das aktive Projekt bereitgestellt. Für Firebase Hosting ist eine Konfigurationsdatei vom Typ firebase.json erforderlich.
serve	Startet einen lokalen Webserver mit Ihrer Firebase Hosting-Konfiguration. Für Firebase Hosting ist eine Konfigurationsdatei vom Typ firebase.json erforderlich.

App Distribution-Befehle

Befehl	Beschreibung
appdistribution:distribute \ --app FIREBASE_APP_ID	Stellt den Build für Tester bereit.
appdistribution:testers:add	Fügen Sie dem Projekt Tester hinzu.
appdistribution:testers:remove	Entfernt Tester aus dem Projekt.

App Hosting-Befehle

Befehl	Beschreibung
apphosting:backends:create \ --project PROJECT_ID \ --location REGION --app APP_ID	Erstellt die Sammlung der verwalteten Ressourcen, die mit einer einzelnen Codebasis verknüpft sind, die ein App Hosting-Backend enthält. Optional können Sie eine vorhandene Firebase-Web-App anhand ihrer Firebase-App-ID angeben.
apphosting:backends:get \ BACKEND_ID \ --project PROJECT_ID \ --location REGION	Ruft bestimmte Details, einschließlich der öffentlichen URL, eines Back-Ends ab.
apphosting:backends:list \ --project PROJECT_ID	Ruft eine Liste aller aktiven Back-Ends ab, die mit einem Projekt verknüpft sind.
firebase apphosting:backends:delete \ BACKEND_ID \ --project PROJECT_ID \ --location REGION	Löscht ein Backend aus dem Projekt.
firebase apphosting:config:export \ --project PROJECT_ID \ --secrets ENVIRONMENT_NAME	Exportiert Secrets zur Verwendung in der App-Emulation. Standardmäßig werden in apphosting.yaml gespeicherte Secrets verwendet. Mit --secrets können Sie eine beliebige Umgebung mit einer entsprechenden apphosting.ENVIRONMENT_NAME.yaml-Datei angeben.
firebase apphosting:rollouts:create \ BACKEND_ID \ --git_branch BRANCH_NAME \ --git_commit COMMIT_ID	Erstellt ein manuell ausgelöstes Roll-out. Optional: Geben Sie den letzten Commit für einen Branch oder einen bestimmten Commit an. Wenn keine Optionen angegeben sind, wird eine Auswahl aus einer Liste von Filialen angezeigt.
apphosting:secrets:set KEY --project PROJECT_ID \ --location REGION \ --data-file DATA_FILE_PATH	Speichert vertrauliche Daten in Secret Manager. Optional: Geben Sie einen Dateipfad an, aus dem geheime Daten gelesen werden sollen. Legen Sie _ fest, um geheime Daten aus der Standardeingabe zu lesen.
apphosting:secrets:grantaccess KEY BACKEND_ID \ --project PROJECT_ID \ --location REGION	Gewährt dem Backend-Dienstkonto Zugriff auf das bereitgestellte Secret, damit App Hosting bei der Build- oder Laufzeit darauf zugreifen kann.
apphosting:secrets:describe KEY \ --project PROJECT_ID	Ruft die Metadaten für ein Secret und seine Versionen ab.
firebase apphosting:secrets:access \ KEY[@version] \ --project PROJECT_ID	Ruft einen Secret-Wert anhand des Secrets und seiner Version ab. Standardmäßig wird auf die neueste Version zugegriffen.

Authentication-Befehle (Nutzerverwaltung)

Befehl	Beschreibung
auth:export	Exportiert die Nutzerkonten des aktiven Projekts in eine JSON- oder CSV-Datei. Weitere Informationen finden Sie auf der Seite auth:import und auth:export.
auth:import	Importiert die Nutzerkonten aus einer JSON- oder CSV-Datei in das aktive Projekt. Weitere Informationen finden Sie auf der Seite auth:import und auth:export.

Cloud Firestore-Befehle

Befehl	Beschreibung
firestore:locations	Liste der verfügbaren Speicherorte für Ihre Cloud Firestore-Datenbank.
firestore:databases:create DATABASE_ID	Erstellen Sie in Ihrem Firebase-Projekt eine Datenbankinstanz im nativen Modus. Der Befehl akzeptiert die folgenden Flags: --location <region name>, um den Bereitstellungsort für die Datenbank anzugeben. Sie können firebase firestore:locations ausführen, um eine Liste der verfügbaren Standorte aufzurufen. Erforderlich. --delete-protection <deleteProtectionState> zum Zulassen oder Verhindern des Löschens der angegebenen Datenbank. Gültige Werte sind ENABLED und DISABLED. Die Standardeinstellung ist DISABLED. --point-in-time-recovery <PITRState>, um festzulegen, ob die Wiederherstellung zu einem bestimmten Zeitpunkt aktiviert ist. Gültige Werte sind ENABLED und DISABLED. Die Standardeinstellung ist DISABLED. Optional.
firestore:databases:list	Listen Sie die Datenbanken in Ihrem Firebase-Projekt auf.
firestore:databases:get DATABASE_ID	Ruft die Datenbankkonfiguration für eine bestimmte Datenbank in Ihrem Firebase-Projekt ab.
firestore:databases:update DATABASE_ID	Aktualisieren Sie die Datenbankkonfiguration einer bestimmten Datenbank in Ihrem Firebase-Projekt. Es ist mindestens eine Kennzeichnung erforderlich. Der Befehl akzeptiert die folgenden Flags: --delete-protection <deleteProtectionState> zum Zulassen oder Verhindern des Löschens der angegebenen Datenbank. Gültige Werte sind ENABLED und DISABLED. Die Standardeinstellung ist DISABLED. --point-in-time-recovery <PITRState>, um festzulegen, ob die Wiederherstellung zu einem bestimmten Zeitpunkt aktiviert ist. Gültige Werte sind ENABLED und DISABLED. Die Standardeinstellung ist DISABLED. Optional.
firestore:databases:delete DATABASE_ID	Löschen Sie eine Datenbank in Ihrem Firebase-Projekt.
firestore:indexes	Indexe für eine Datenbank in Ihrem Firebase-Projekt auflisten Der Befehl akzeptiert das folgende Flag: --database DATABASE_ID: Gibt den Namen der Datenbank an, für die Indexe aufgelistet werden sollen. Wenn keine Angabe gemacht wird, werden Indexe für die Standarddatenbank aufgeführt.
firestore:delete	Löscht Dokumente in der Datenbank des aktiven Projekts. Mit der Befehlszeile können Sie alle Dokumente in einer Sammlung rekursiv löschen. Beachten Sie, dass beim Löschen von Cloud Firestore-Daten über die Befehlszeile Kosten für das Lesen und Löschen anfallen. Weitere Informationen finden Sie unter Cloud Firestore-Abrechnung. Der Befehl akzeptiert das folgende Flag: --database DATABASE_ID Gibt den Namen der Datenbank an, aus der Dokumente gelöscht werden. Wenn keine Angabe erfolgt, werden Dokumente aus der Standarddatenbank gelöscht. Optional.

Cloud Functions for Firebase-Befehle

Befehl	Beschreibung
functions:config:clone	Die Umgebung eines anderen Projekts wird in das aktive Firebase-Projekt geklont.
functions:config:get	Ruft vorhandene Konfigurationswerte der Cloud Functions des aktiven Projekts ab.
functions:config:set	Hier werden die Werte der Laufzeitkonfiguration von Cloud Functions des aktiven Projekts gespeichert.
functions:config:unset	Entfernt Werte aus der Laufzeitkonfiguration des aktiven Projekts.
functions:log	Liest Protokolle aus bereitgestellten Cloud Functions.

Weitere Informationen finden Sie in der Dokumentation zur Umgebungskonfiguration.

Crashlytics-Befehle

Befehl	Beschreibung
crashlytics:mappingfile:generateid \ --resource-file=PATH/TO/ANDROID_RESOURCE.XML	Er generiert eine eindeutige Zuordnungsdatei-ID in der angegebenen Android-Ressourcendatei (XML).
crashlytics:mappingfile:upload \ --app=FIREBASE_APP_ID \ --resource-file=PATH/TO/ANDROID_RESOURCE.XML \ PATH/TO/MAPPING_FILE.TXT	Hier wird eine Proguard-kompatible Zuordnungsdatei (TXT) für diese App hochgeladen und mit der in der angegebenen Android-Ressourcendatei (XML) deklarierten Zuordnungsdatei-ID verknüpft.
crashlytics:symbols:upload \ --app=FIREBASE_APP_ID \ PATH/TO/SYMBOLS	Er generiert eine Crashlytics-kompatible Symboldatei für Abstürze der nativen Bibliothek unter Android und lädt sie auf die Firebase-Server hoch.

Data Connect-Befehle

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

Befehl	Beschreibung
dataconnect:services:list	Listet alle bereitgestellten Data Connect-Dienste in Ihrem Firebase-Projekt auf.
dataconnect:sql:diff \ SERVICE_ID	Zeigt für den angegebenen Dienst die Unterschiede zwischen einem lokalen Data Connect-Schema und dem Cloud SQL-Datenbankschema an.
dataconnect:sql:migrate \ --force \ SERVICE_ID	Das Schema Ihrer Cloud SQL-Datenbank wird an das lokale Data Connect-Schema angepasst.
dataconnect:sql:grant\ --role=ROLE \ --email=EMAIL \ SERVICE_ID	Die SQL-Rolle wird der angegebenen E-Mail-Adresse des Nutzers oder Dienstkontos gewährt. Für das Flag --role kann eine der folgenden SQL-Rollen gewährt werden: owner, writer oder reader. Geben Sie für das Flag --email die E-Mail-Adresse des Nutzers oder Dienstkontos an, dem Sie die Rolle zuweisen möchten.
dataconnect:sdk:generate	Generiert typisierte SDKs für Ihre Data Connect-Connectors.

Extensions-Befehle

Befehl	Beschreibung
ext	Zeigt Informationen zur Verwendung von Firebase Extensions-Befehlen an. Listet die Erweiterungsinstanzen auf, die im aktiven Projekt installiert sind.
ext:configure \ EXTENSION_INSTANCE_ID	Die Parameterwerte einer Erweiterungs-Instanz werden im Manifest der Erweiterung neu konfiguriert.
ext:info \ PUBLISHER_ID/EXTENSION_ID	Druckt detaillierte Informationen zu einer Erweiterung aus.
ext:install \ PUBLISHER_ID/EXTENSION_ID	Fügt dem Manifest der Erweiterung eine neue Instanz einer Erweiterung hinzu.
ext:list	Listet alle Erweiterungsinstanzen auf, die in einem Firebase-Projekt installiert sind. Die Instanz-ID für jede Erweiterung wird ausgegeben.
ext:uninstall \ EXTENSION_INSTANCE_ID	Entfernt eine Erweiterungs-Instanz aus Ihrem Erweiterungsmanifest.
ext:update \ EXTENSION_INSTANCE_ID	Aktualisiert eine Erweiterungs-Instanz auf die neueste Version in Ihrem Erweiterungsmanifest.
ext:export	Exportiert alle installierten Erweiterungsinstanzen aus Ihrem Projekt in Ihr Erweiterungsmanifest.

Extensions Publisher-Befehle

Befehl	Beschreibung
ext:dev:init	Initialisiert eine Skelett-Codebasis für eine neue Erweiterung im aktuellen Verzeichnis.
ext:dev:list \ PUBLISHER_ID	Liste aller von einem Verlag oder Webpublisher hochgeladenen Erweiterungen.
ext:dev:register	Firebase-Projekt als Projekt eines Erweiterungsanbieters registrieren
ext:dev:deprecate \ PUBLISHER_ID/EXTENSION_ID \ VERSION_PREDICATE	Ersetzt Erweiterungsversionen, die dem Versionsprädikat entsprechen. Ein Versionsprädikat kann eine einzelne Version (z. B. 1.0.0) oder ein Versionsbereich (z. B. >1.0.0) sein. Wenn kein Versionsprädikat angegeben wird, werden alle Versionen dieser Erweiterung verworfen.
ext:dev:undeprecate \ PUBLISHER_ID/EXTENSION_ID \ VERSION_PREDICATE	Entfernt die Einstellung für Erweiterungsversionen, die mit dem Versionsprädikat übereinstimmen. Ein Versionsprädikat kann eine einzelne Version (z. B. 1.0.0) oder ein Versionsbereich (z. B. >1.0.0) sein. Wenn kein Versionsprädikat angegeben wird, wird die Einstellung für alle Versionen dieser Erweiterung aufgehoben.
ext:dev:upload \ PUBLISHER_ID/EXTENSION_ID	Hiermit wird eine neue Version einer Erweiterung hochgeladen.
ext:dev:usage \ PUBLISHER_ID	Zeigt die Anzahl der Installationen und Nutzungsmesswerte für von einem Publisher hochgeladene Erweiterungen an.

Hosting-Befehle

Befehl	Beschreibung
hosting:disable	Es wird kein Firebase Hosting-Traffic mehr für das aktive Firebase-Projekt ausgeliefert. Nach Ausführung dieses Befehls wird in der Hosting-URL Ihres Projekts die Meldung „Website nicht gefunden“ angezeigt.
Verwaltung von Hosting Websites
firebase hosting:sites:create \ SITE_ID	Erstellt eine neue Hosting-Website im aktiven Firebase-Projekt mit der angegebenen SITE_ID. Optional: Geben Sie eine vorhandene Firebase-Webanwendung an, die mit der neuen Website verknüpft werden soll, indem Sie das folgende Flag übergeben: --app FIREBASE_APP_ID
firebase hosting:sites:delete \ SITE_ID	Löscht die angegebene Hosting-Website In der Befehlszeile wird eine Bestätigungsaufforderung angezeigt, bevor die Website gelöscht wird. Optional: Überspringen Sie die Bestätigungsaufforderung, indem Sie die folgenden Flags übergeben: -f oder --force
firebase hosting:sites:get \ SITE_ID	Ruft Informationen zur angegebenen Hosting-Website ab
firebase hosting:sites:list	Listet alle Hosting-Websites für das aktive Firebase-Projekt auf
Vorschaukanäle verwalten
firebase hosting:channel:create \ CHANNEL_ID	Erstellt einen neuen Vorschaukanal auf der Standardwebsite Hosting mit der angegebenen CHANNEL_ID. Dieser Befehl führt keine Bereitstellung auf dem Kanal aus.
firebase hosting:channel:delete \ CHANNEL_ID	Löscht den angegebenen Vorschaukanal. Der Livekanal einer Website kann nicht gelöscht werden.
firebase hosting:channel:deploy \ CHANNEL_ID	Deine Hosting-Inhalte und -Konfiguration werden auf dem angegebenen Vorschaukanal bereitgestellt. Wenn der Vorschaukanal noch nicht vorhanden ist, wird er mit diesem Befehl auf der Standardwebsite von Hosting erstellt, bevor er auf dem Kanal bereitgestellt wird.
firebase hosting:channel:list	Listet alle Kanäle (einschließlich des „Live“-Kanals) auf der Standardseite von Hosting auf.
firebase hosting:channel:open \ CHANNEL_ID	Öffnet einen Browser mit der URL des angegebenen Kanals oder gibt die URL zurück, wenn das Öffnen in einem Browser nicht möglich ist.
Klonen von Versionen
firebase hosting:clone \ SOURCE_SITE_ID:SOURCE_CHANNEL_ID \ TARGET_SITE_ID:TARGET_CHANNEL_ID	Die zuletzt bereitgestellte Version auf dem angegebenen Quellkanal wird auf dem angegebenen Zielkanal geklont. Mit diesem Befehl wird die Bereitstellung auch auf dem angegebenen „target“-Kanal durchgeführt. Wenn der Kanal „target“ noch nicht vorhanden ist, wird mit diesem Befehl ein neuer Vorschaukanal auf der Hosting-Website „target“ erstellt, bevor die Bereitstellung auf dem Kanal erfolgt.
firebase hosting:clone \ SOURCE_SITE_ID:@VERSION_ID \ TARGET_SITE_ID:TARGET_CHANNEL_ID	Die angegebene Version wird auf den angegebenen Zielkanal geklont. Mit diesem Befehl wird die Bereitstellung auch auf dem angegebenen „target“-Kanal durchgeführt. Wenn der Kanal „target“ noch nicht vorhanden ist, wird mit diesem Befehl ein neuer Vorschaukanal auf der Hosting-Website „target“ erstellt, bevor die Bereitstellung auf dem Kanal erfolgt. Sie finden die VERSION_ID im Hosting-Dashboard der Firebase-Konsole.

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.

Befehl	Beschreibung
database:get	Hiermit werden Daten aus der Datenbank des aktiven Projekts abgerufen und als JSON angezeigt. Unterstützt Abfragen auf indexierten Daten.
database:instances:create	Erstellt eine Datenbankinstanz mit einem angegebenen Instanznamen. Die Option --location zum Erstellen einer Datenbank in einer bestimmten Region wird akzeptiert. Informationen zu den Regionsnamen, die mit dieser Option verwendet werden können, finden Sie unter Standorte für Ihr Projekt auswählen. Wenn für das aktuelle Projekt keine Datenbankinstanz vorhanden ist, werden Sie aufgefordert, den firebase init-Vorgang auszuführen, um eine Instanz zu erstellen.
database:instances:list	Listet alle Datenbankinstanzen für dieses Projekt auf. Die Option --location zum Auflisten von Datenbanken in einer bestimmten Region wird akzeptiert. Informationen zu den Regionsnamen, die mit dieser Option verwendet werden können, finden Sie unter Standorte für Ihr Projekt auswählen.
database:profile	Erstellt ein Profil der Vorgänge in der Datenbank des aktiven Projekts. Weitere Informationen finden Sie unter Realtime Database-Vorgänge.
database:push	Neue Daten werden an eine Liste an einem bestimmten Ort in der Datenbank des aktiven Projekts gesendet. Nimmt Eingaben aus einer Datei, STDIN oder einem Befehlszeilenargument entgegen.
database:remove	Löscht alle Daten an einem bestimmten Speicherort in der Datenbank des aktiven Projekts.
database:set	Ersetzt alle Daten an einem bestimmten Speicherort in der Datenbank des aktiven Projekts. Nimmt Eingaben aus einer Datei, STDIN oder einem Befehlszeilenargument entgegen.
database:update	Führt an einem bestimmten Ort in der Datenbank des aktiven Projekts eine teilweise Aktualisierung durch. Nimmt Eingaben aus einer Datei, STDIN oder einem Befehlszeilenargument entgegen.

Remote Config-Befehle

Befehl	Beschreibung
remoteconfig:versions:list \ --limit NUMBER_OF_VERSIONS	Hier werden die zehn neuesten Versionen der Vorlage aufgeführt. Geben Sie 0 an, um alle vorhandenen Versionen zurückzugeben, oder geben Sie optional die Option --limit an, um die Anzahl der zurückgegebenen Versionen zu begrenzen.
remoteconfig:get \ --v, version_number VERSION_NUMBER --o, output FILENAME	Ruft die Vorlage nach Version ab (standardmäßig die neueste Version) und gibt die Parametergruppen, Parameter, Bedingungsnamen und Version in einer Tabelle aus. Optional können Sie die Ausgabe mit -o, FILENAME in eine angegebene Datei schreiben.
remoteconfig:rollback \ --v, version_number VERSION_NUMBER --force	Führt ein Rollback der Remote Config-Vorlage auf eine angegebene vorherige Versionsnummer oder standardmäßig auf die unmittelbar vorhergehende Version (aktuelle Version − 1) durch. Sofern --force nicht übergeben wird, wird J/N angezeigt, bevor mit dem Rollback fortgefahren wird.