Documentation de référence de la CLI Firebase

La CLI Firebase (GitHub) fournit divers outils pour la gestion, l'affichage et le déploiement dans des projets Firebase.

Avant d'utiliser la CLI Firebase, configurez un projet Firebase.

Configurer ou mettre à jour la CLI

Installer la CLI Firebase

Vous pouvez installer la CLI Firebase en utilisant une méthode qui correspond à votre système d'exploitation, à votre niveau d'expérience et/ou à votre cas d'utilisation. Quelle que soit la façon dont vous installez la CLI, vous avez accès aux mêmes fonctionnalités et à la commande firebase.

Windows macOS Linux

Windows

Vous pouvez installer la CLI Firebase pour Windows en utilisant l'une des options suivantes:

Option	Description	Recommandé pour...
binaire autonome	Téléchargez le binaire autonome pour la CLI. Vous pouvez ensuite accéder au fichier exécutable pour ouvrir une interface système dans laquelle vous pouvez exécuter la commande firebase.	Nouveaux développeurs Développeurs qui n'utilisent pas Node.js ou ne connaissent pas ce langage
npm	Utiliser npm (le gestionnaire de packages de nœuds) pour installer la CLI et activer la commande firebase disponible dans le monde entier	Développeurs utilisant Node.js

macOS ou Linux

Vous pouvez installer la CLI Firebase pour macOS ou Linux en utilisant l'une des options suivantes:

Option	Description	Recommandé pour...
script d'installation automatique	Exécutez une commande unique qui détecte automatiquement votre système d'exploitation, télécharge la dernière version de la CLI, puis active la commande firebase disponible dans le monde entier.	Nouveaux développeurs Développeurs qui n'utilisent pas Node.js ou ne connaissent pas l'utilisation de Node.js Déploiements automatisés dans un environnement CI/CD
binaire autonome	Téléchargez le binaire autonome pour la CLI. Vous pouvez ensuite configurer et exécuter le binaire en fonction de votre workflow.	Workflows entièrement personnalisables à l'aide de la CLI
npm	Utiliser npm (le gestionnaire de packages de nœuds) pour installer la CLI et activer la commande firebase disponible dans le monde entier	Développeurs utilisant Node.js

Se connecter et tester la CLI Firebase

Après avoir installé la CLI, vous devez vous authentifier. Vous pouvez ensuite confirmer l'authentification en répertoriant vos projets Firebase.

1. Connectez-vous à Firebase à l'aide de votre compte Google en exécutant la commande suivante:

   firebase login

   Cette commande connecte votre ordinateur local à Firebase et vous donne accès à vos projets Firebase.

2. Vérifiez que la CLI est correctement installée et qu'elle accède à votre compte en répertoriant vos projets Firebase. Exécutez la commande ci-dessous.

   firebase projects:list

   La liste affichée doit être identique aux projets Firebase répertoriés dans la console Firebase.

Installer la dernière version de la CLI

En règle générale, il est préférable d'utiliser la version la plus récente de la CLI Firebase.

La manière dont vous mettez à jour la version de la CLI dépend de votre système d'exploitation et de la manière dont vous avez installé la CLI.

Utiliser la CLI avec des systèmes CI

La CLI Firebase nécessite un navigateur pour effectuer l'authentification, mais elle est entièrement compatible avec la CI et d'autres environnements sans interface graphique.

1. Sur une machine dotée d'un navigateur, installez la CLI Firebase.

2. Lancez le processus de connexion en exécutant la commande suivante:

   firebase login:ci

3. Accédez à l'URL fournie, puis connectez-vous à l'aide d'un compte Google.

4. Imprimez un nouveau jeton d'actualisation. La session actuelle de la CLI ne sera pas affectée.

5. Stockez le jeton de sortie de manière sécurisée et accessible dans votre système CI.

6. Utilisez ce jeton lorsque vous exécutez des commandes firebase. Vous pouvez utiliser l'une des deux options suivantes:

   • Option 1:stockez le jeton en tant que variable d'environnement FIREBASE_TOKEN. Votre système utilisera automatiquement le jeton.

   • Option 2:exécutez toutes les commandes firebase avec l'indicateur --token TOKEN dans votre système CI.
     Voici l'ordre de priorité pour le chargement des jetons: option, variable d'environnement et projet Firebase souhaité.

Initialiser un projet Firebase

De nombreuses tâches courantes effectuées à l'aide de la CLI, comme le déploiement dans un projet Firebase, nécessitent un répertoire de projet. Vous créez un répertoire de projet à l'aide de la commande firebase init. Un répertoire de projet est généralement le même que votre répertoire racine du contrôle des sources. Après l'exécution de firebase init, le répertoire contient un fichier de configuration firebase.json.

Pour initialiser un nouveau projet Firebase, exécutez la commande suivante depuis le répertoire de votre application:

firebase init

La commande firebase init vous guide tout au long de la configuration du répertoire de votre projet et de certains produits Firebase. Lors de l'initialisation du projet, la CLI Firebase vous demande d'effectuer les tâches suivantes:

• Sélectionnez les produits Firebase à configurer dans votre projet Firebase.

  Cette étape vous invite à définir des configurations pour des fichiers spécifiques pour les produits sélectionnés. Pour en savoir plus sur ces configurations, consultez la documentation du produit concerné (par exemple, Hébergement). Notez que vous pourrez toujours exécuter firebase init plus tard pour configurer d'autres produits Firebase.

• Sélectionnez un projet Firebase par défaut.

  Cette étape associe le répertoire actuel du projet à un projet Firebase afin que les commandes spécifiques au projet (telles que firebase deploy) s'exécutent sur le projet Firebase approprié.

  Il est également possible d'associer plusieurs projets Firebase (par exemple, un projet de préproduction et un projet de production) au même répertoire de projet.

À la fin de l'initialisation, Firebase crée automatiquement les deux fichiers suivants à la racine du répertoire local de votre application:

• Un fichier de configuration firebase.json qui répertorie la configuration de votre projet.

• Un fichier .firebaserc qui stocke les aliases de votre projet.

Le fichier firebase.json

La commande firebase init crée un fichier de configuration firebase.json à la racine du répertoire de votre projet.

Le fichier firebase.json est nécessaire pour déployer des éléments avec la CLI Firebase, car il spécifie les fichiers et les paramètres de votre répertoire de projet qui sont déployés dans votre projet Firebase. Étant donné que certains paramètres peuvent être définis dans le répertoire de votre projet ou dans la console Firebase, veillez à résoudre les éventuels conflits de déploiement.

Vous pouvez configurer la plupart des options Firebase Hosting directement dans le fichier firebase.json. Toutefois, pour les autres services Firebase pouvant être déployés avec la CLI Firebase, la commande firebase init crée des fichiers spécifiques dans lesquels vous pouvez définir des paramètres pour ces services, tels qu'un fichier index.js pour Cloud Functions. Vous pouvez également configurer des hooks de prédéploiement ou de postdéploiement dans le fichier firebase.json.

Voici un exemple de fichier firebase.json avec les paramètres par défaut si vous sélectionnez Firebase Hosting, Cloud Firestore et Cloud Functions for Firebase (avec les options de source TypeScript et lint sélectionnées) lors de l'initialisation.

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

Bien que firebase.json soit utilisé par défaut, vous pouvez transmettre l'option --config PATH pour spécifier un autre fichier de configuration.

Configuration pour plusieurs bases de données Cloud Firestore

Lorsque vous exécutez firebase init, votre fichier firebase.json contient une seule clé firestore correspondant à la base de données par défaut de votre projet, comme indiqué ci-dessus.

Si votre projet contient plusieurs bases de données Cloud Firestore, modifiez votre fichier firebase.json pour associer des règles de sécurité Cloud Firestore et des fichiers sources d'index de base de données différents à chaque base de données. Modifiez le fichier avec un tableau JSON, avec une entrée pour chaque base de données.

      "firestore": [
        {
          "database": "default",
          "rules": "firestore.default.rules",
          "indexes": "firestore.default.indexes.json"
        },
        {
          "database": "ecommerce",
          "rules": "firestore.ecommerce.rules",
          "indexes": "firestore.ecommerce.indexes.json"
        }
      ],

Fichiers Cloud Functions à ignorer lors du déploiement

Au moment du déploiement de la fonction, la CLI spécifie automatiquement une liste de fichiers à ignorer dans le répertoire functions. Cela empêche le déploiement sur le backend de fichiers superflus qui pourraient augmenter la taille des données de votre déploiement.

Voici la liste des fichiers ignorés par défaut (affichée au format JSON) :

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

Si vous ajoutez vos propres valeurs personnalisées pour ignore dans firebase.json, assurez-vous de conserver (ou d'ajouter, si elle est manquante) la liste des fichiers ci-dessus.

Gérer les alias de projet

Vous pouvez associer plusieurs projets Firebase au même répertoire de projet. Par exemple, vous pouvez utiliser un projet Firebase pour la préproduction et un autre pour la production. En utilisant différents environnements de projet, vous pouvez vérifier les modifications avant de les déployer en production. La commande firebase use vous permet de basculer entre les alias et d'en créer d'autres.

Ajouter un alias de projet

Lorsque vous sélectionnez un projet Firebase lors de l'initialisation du projet, l'alias default est automatiquement attribué au projet. Toutefois, pour autoriser l'exécution de commandes spécifiques à un projet sur un autre projet Firebase tout en utilisant le même répertoire de projet, exécutez la commande suivante depuis le répertoire de votre projet:

firebase use --add

Cette commande vous invite à sélectionner un autre projet Firebase et à l'attribuer en tant qu'alias. Les attributions d'alias sont écrites dans un fichier .firebaserc du répertoire de votre projet.

Utiliser des alias de projet

Pour utiliser les alias de projet Firebase attribués, exécutez l'une des commandes suivantes à partir du répertoire de votre projet.

Commande	Description
firebase use	Afficher la liste des alias actuellement définis pour le répertoire de votre projet
firebase use \ PROJECT_ID|ALIAS	Ordonne à toutes les commandes de s'exécuter sur le projet Firebase spécifié. La CLI utilise ce projet comme "projet actif".
firebase use --clear	Efface le projet actif. Exécutez firebase use PROJECT_ID|ALIAS pour définir un nouveau projet actif avant d'exécuter d'autres commandes CLI.
firebase use \ --unalias PROJECT_ALIAS	Supprime un alias du répertoire de votre projet.

Vous pouvez remplacer le projet actuellement actif en transmettant l'option --project avec n'importe quelle commande CLI. Par exemple, vous pouvez configurer votre CLI pour qu'elle s'exécute sur un projet Firebase auquel vous avez attribué l'alias staging. Si vous souhaitez exécuter une seule commande sur le projet Firebase auquel vous avez attribué l'alias prod, vous pouvez exécuter firebase deploy --project=prod, par exemple.

Contrôle des sources et alias de projet

En général, vous devez vérifier votre fichier .firebaserc dans le contrôle des sources pour permettre à votre équipe de partager des alias de projet. Toutefois, pour les projets Open Source ou les modèles de démarrage, vous ne devez généralement pas vérifier votre fichier .firebaserc.

Si vous disposez d'un projet de développement réservé à votre usage personnel, vous pouvez transmettre l'option --project avec chaque commande ou exécuter firebase use PROJECT_ID sans attribuer d'alias au projet Firebase.

Diffuser et tester votre projet Firebase en local

Vous pouvez afficher et tester votre projet Firebase sur des URL hébergées localement avant de le déployer en production. Si vous souhaitez tester uniquement certaines fonctionnalités, vous pouvez utiliser une liste d'éléments séparés par une virgule dans une option de la commande firebase serve.

Exécutez la commande suivante à partir de la racine du répertoire de votre projet local si vous souhaitez effectuer l'une des tâches suivantes:

• Affichez le contenu statique de votre application hébergée sur Firebase.
• Utilisez Cloud Functions pour générer du contenu dynamique pour Firebase Hosting et vous souhaitez utiliser vos fonctions HTTP de production (déployé) pour émuler Hosting sur une URL locale.

firebase serve --only hosting

Émuler votre projet à l'aide des fonctions HTTP localisées

Exécutez l'une des commandes suivantes à partir du répertoire de votre projet pour émuler votre projet à l'aide des fonctions HTTP localisées.

• Pour émuler les fonctions HTTP et l'hébergement afin d'effectuer des tests sur des URL locales, utilisez l'une des commandes suivantes:

  firebase serve

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

• Pour émuler uniquement des fonctions HTTP, utilisez la commande suivante:

  firebase serve --only functions

Effectuer des tests à partir d'autres appareils locaux

Par défaut, firebase serve ne répond qu'aux requêtes provenant de localhost. Cela signifie que vous pourrez accéder à votre contenu hébergé à partir du navigateur Web de votre ordinateur, mais pas à partir d'autres appareils de votre réseau. Si vous souhaitez effectuer le test à partir d'autres appareils locaux, utilisez l'indicateur --host, comme suit:

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

Déployer dans un projet Firebase

La CLI Firebase gère le déploiement du code et des éléments dans votre projet Firebase, y compris:

• Nouveautés de vos sites Firebase Hosting
• Fonctions Cloud Functions for Firebase nouvelles, mises à jour ou existantes
• Règles pour Firebase Realtime Database
• Règles pour Cloud Storage for Firebase
• Règles pour Cloud Firestore
• Index pour Cloud Firestore

Pour déployer dans un projet Firebase, exécutez la commande suivante à partir du répertoire de votre projet:

firebase deploy

Vous pouvez éventuellement ajouter un commentaire à chacun de vos déploiements. Ce commentaire s'affiche avec les autres informations de déploiement sur la page Firebase Hosting de votre projet. Exemple :

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

Lorsque vous utilisez la commande firebase deploy, tenez compte des points suivants:

• Pour que vous puissiez déployer des ressources à partir d'un répertoire de projet, ce répertoire doit contenir un fichier firebase.json. Ce fichier est créé automatiquement par la commande firebase init.

• Par défaut, firebase deploy crée une version pour toutes les ressources déployables dans le répertoire de votre projet. Pour déployer des services ou fonctionnalités Firebase spécifiques, optez pour le déploiement partiel.

Conflits de déploiement liés aux règles de sécurité

Pour Firebase Realtime Database, Cloud Storage for Firebase et Cloud Firestore, vous pouvez définir des règles de sécurité dans le répertoire local de votre projet ou dans la console Firebase.

Une autre option pour éviter les conflits de déploiement consiste à utiliser le déploiement partiel et à ne définir des règles que dans la console Firebase.

Quotas de déploiement

Il est possible (mais peu probable) de dépasser un quota qui limite le débit ou le volume de vos opérations de déploiement Firebase. Par exemple, lorsque vous déployez un très grand nombre de fonctions, vous pouvez recevoir un message d'erreur HTTP 429 Quota. Pour résoudre ces problèmes, essayez d'utiliser le déploiement partiel.

Effectuer le rollback d'un déploiement

Vous pouvez effectuer un rollback d'un déploiement Firebase Hosting à partir de la page Firebase Hosting de votre projet en sélectionnant l'action Rollback pour la version souhaitée.

Il n'est actuellement pas possible d'effectuer un rollback de versions des règles de sécurité pour Firebase Realtime Database, Cloud Storage for Firebase ou Cloud Firestore.

Déployer des services Firebase spécifiques

Si vous souhaitez ne déployer que des services ou fonctionnalités Firebase spécifiques, vous pouvez utiliser une liste d'éléments séparés par une virgule dans une option de la commande firebase deploy. Par exemple, la commande suivante déploie du contenu Firebase Hosting et des règles de sécurité Cloud Storage.

firebase deploy --only hosting,storage

Le tableau suivant répertorie les services et les fonctionnalités disponibles pour un déploiement partiel. Les noms des options correspondent aux clés de votre fichier de configuration firebase.json.

Syntaxe de l'indicateur	Service ou fonctionnalité déployés
--only hosting	Contenu Firebase Hosting
--only database	Règles Firebase Realtime Database
--only storage	Règles Cloud Storage for Firebase
--only firestore	Règles Cloud Firestore et index pour toutes les bases de données configurées
--only functions	Cloud Functions for Firebase (des versions plus spécifiques de cette option sont possibles) ;

Déployer des fonctions spécifiques

Lorsque vous déployez des fonctions, vous pouvez cibler des fonctions spécifiques. Exemple :

firebase deploy --only functions:function1

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

Une autre option consiste à regrouper les fonctions dans des groupes d'exportation dans votre fichier /functions/index.js. Les fonctions de regroupement vous permettent de déployer plusieurs fonctions à l'aide d'une seule commande.

Par exemple, vous pouvez écrire les fonctions suivantes pour définir un groupA et un groupB:

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

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

Dans cet exemple, un fichier functions/groupB.js distinct contient des fonctions supplémentaires qui les définissent spécifiquement dans groupB. Exemple :

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

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

Dans cet exemple, vous pouvez déployer toutes les fonctions groupA en exécutant la commande suivante à partir du répertoire de votre projet:

firebase deploy --only functions:groupA

Vous pouvez également cibler une fonction spécifique dans un groupe en exécutant la commande suivante:

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

Supprimer les fonctions

La CLI Firebase accepte les commandes et options suivantes pour supprimer des fonctions précédemment déployées:

• Supprime toutes les fonctions qui correspondent au nom spécifié dans toutes les régions :

  firebase functions:delete FUNCTION-1_NAME

• Supprime une fonction spécifiée exécutée dans une région autre que celle par défaut :

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

• Supprime plusieurs fonctions :

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

• Supprime un groupe de fonctions spécifié :

  firebase functions:delete GROUP_NAME

• Contourne l'invite de confirmation :

  firebase functions:delete FUNCTION-1_NAME --force

Configurer des tâches à l'aide de scripts de prédéploiement et de post-déploiement

Vous pouvez connecter des scripts shell à la commande firebase deploy pour effectuer des tâches de prédéploiement ou de postdéploiement. Par exemple, un script de prédéploiement peut transpiler du code TypeScript en JavaScript, et un hook de postdéploiement peut avertir les administrateurs du déploiement du nouveau contenu du site sur Firebase Hosting.

Pour configurer des hooks de prédéploiement ou de postdéploiement, ajoutez des scripts bash à votre fichier de configuration firebase.json. Vous pouvez définir de brefs scripts directement dans le fichier firebase.json ou référencer d'autres fichiers qui se trouvent dans le répertoire de votre projet.

Par exemple, le script suivant est l'expression firebase.json d'une tâche de postdéploiement qui envoie un message Slack une fois le déploiement effectué sur Firebase Hosting.

"hosting": {
  // ...

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

Le fichier de script messageSlack.sh se trouve dans le répertoire du projet et se présente comme suit:

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

Vous pouvez configurer des hooks predeploy et postdeploy pour tous les éléments que vous pouvez déployer. Notez que l'exécution de firebase deploy déclenche toutes les tâches de prédéploiement et de postdéploiement définies dans le fichier firebase.json. Pour n'exécuter que les tâches associées à un service Firebase spécifique, utilisez des commandes de déploiement partiel.

Les hooks predeploy et postdeploy impriment les flux de sortie et d'erreur standards des scripts sur le terminal. En cas d'échec, veuillez noter les points suivants:

• Si un hook de prédéploiement ne se termine pas comme prévu, le déploiement est annulé.
• En cas d'échec du déploiement pour une raison quelconque, les hooks de postdéploiement ne sont pas déclenchés.

Variables d'environnement

Dans les scripts exécutés dans les hooks de prédéploiement et de postdéploiement, les variables d'environnement suivantes sont disponibles:

• $GCLOUD_PROJECT: ID du projet actif
• $PROJECT_DIR: répertoire racine contenant le fichier firebase.json
• $RESOURCE_DIR: (pour les scripts hosting et functions uniquement) l'emplacement du répertoire contenant les ressources Hosting ou Cloud Functions à déployer

Gérer plusieurs instances Realtime Database

Un projet Firebase peut avoir plusieurs instances Firebase Realtime Database. Par défaut, les commandes CLI interagissent avec votre instance de base de données par défaut.

Toutefois, vous pouvez interagir avec une instance de base de données autre que celle par défaut à l'aide de l'option --instance DATABASE_NAME. Les commandes suivantes sont compatibles avec l'option --instance:

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

Documentation de référence sur les commandes

Commandes d'administration de la CLI

Commande	Description
help	Affiche des informations d'aide concernant la CLI ou des commandes spécifiques.
init	Associe et configure un nouveau projet Firebase dans le répertoire actuel. Cette commande crée un fichier de configuration firebase.json dans le répertoire actuel.
login	Authentifie la CLI sur votre compte Firebase. Nécessite l'accès à un navigateur Web. Pour vous connecter à la CLI dans des environnements distants qui n'autorisent pas l'accès à localhost, utilisez l'option --no-localhost.
login:ci	Il génère un jeton d'authentification à utiliser dans les environnements non interactifs.
se déconnecter	Déconnectez la CLI de votre compte Firebase.
ouvrir	Ouvre un navigateur vers les ressources du projet pertinentes.
projects:list	Répertorie tous les projets Firebase auxquels vous avez accès.
utiliser	Définit le projet Firebase actif pour la CLI. Gère les alias de projets.

Commandes de gestion de projet

Commande	Description
Gestion des projets Firebase
projects:addfirebase	Ajoute des ressources Firebase à un projet Google Cloud existant.
projects:create.	Crée un projet Google Cloud, puis y ajoute des ressources Firebase.
projects:list	Répertorie tous les projets Firebase auxquels vous avez accès.
Gestion des applications Firebase (iOS, Android, Web)
apps:create.	Crée une application Firebase dans le projet actif.
apps:list	Répertorie les applications Firebase enregistrées dans le projet actif.
apps:sdkconfig	Affiche la configuration des services Google d'une application Firebase.
setup:web	Obsolète. Utilisez plutôt apps:sdkconfig et spécifiez web comme argument de plate-forme. Affiche la configuration des services Google d'une application Web Firebase.
Gestion des hachages de certificat SHA (Android uniquement)
apps:android:sha:create \ FIREBASE_APP_ID SHA_HASH	Ajoute le hachage de certificat SHA spécifié à l'application Android Firebase spécifiée.
apps:android:sha:delete \ FIREBASE_APP_ID SHA_HASH	Supprime le hachage de certificat SHA spécifié de l'application Android Firebase spécifiée.
apps:android:sha:list \ FIREBASE_APP_ID	Répertorie les hachages de certificat SHA pour l'application Android Firebase spécifiée.

Déploiement et développement local

Ces commandes vous permettent de déployer votre site Firebase Hosting et d'interagir avec celui-ci.

Commande	Description
deploy	Déploie le code et les éléments de votre répertoire de projet dans le projet actif. Pour Firebase Hosting, un fichier de configuration firebase.json est requis.
servir	Démarre un serveur Web local avec votre configuration Firebase Hosting. Pour Firebase Hosting, un fichier de configuration firebase.json est requis.

Commandes App Distribution

Commande	Description
appdistribution:distribute \ --app FIREBASE_APP_ID	Met le build à la disposition des testeurs.
appdistribution:testers:add	Ajoute des testeurs au projet.
appdistribution:testers:remove	Supprime les testeurs du projet.

Commandes d'authentification (gestion des utilisateurs)

Commande	Description
auth:export	Exporte les comptes utilisateur du projet actif dans un fichier JSON ou CSV. Pour plus d'informations, reportez-vous aux pages auth:import et auth:export.
auth:import	Importe les comptes utilisateur à partir d'un fichier JSON ou CSV dans le projet actif. Pour plus d'informations, reportez-vous aux pages auth:import et auth:export.

Commandes Cloud Firestore

Commande	Description
firestore:locations	Répertoriez les emplacements disponibles pour votre base de données Cloud Firestore.
firestore:databases:create DATABASE_ID	Créez une instance de base de données en mode natif dans votre projet Firebase. La commande utilise les indicateurs suivants: --location <nom de la région> pour spécifier l'emplacement de déploiement de la base de données. Notez que vous pouvez exécuter firebasefirestore:locations pour répertorier les emplacements disponibles. Obligatoire. --delete-protection <deleteProtectionState> pour autoriser ou empêcher la suppression de la base de données spécifiée. Les valeurs valides sont ENABLED ou DISABLED. La valeur par défaut est DISABLED. --point-in-time-recovery <PITRState> pour définir si la récupération à un moment précis est activée. Les valeurs valides sont ENABLED ou DISABLED. La valeur par défaut est DISABLED. Facultatif.
firestore:databases:list	Répertoriez les bases de données de votre projet Firebase.
firestore:databases:get DATABASE_ID	Obtenez la configuration de la base de données spécifiée dans votre projet Firebase.
firestore:databases:update DATABASE_ID	Mettez à jour la configuration d'une base de données spécifiée dans votre projet Firebase. Veuillez indiquer au moins un indicateur. La commande utilise les indicateurs suivants: --delete-protection <deleteProtectionState> pour autoriser ou empêcher la suppression de la base de données spécifiée. Les valeurs valides sont ENABLED ou DISABLED. La valeur par défaut est DISABLED. --point-in-time-recovery <PITRState> pour définir si la récupération à un moment précis est activée. Les valeurs valides sont ENABLED ou DISABLED. La valeur par défaut est DISABLED. Facultatif.
firestore:databases:delete DATABASE_ID	Supprimez une base de données de votre projet Firebase.
firestore:indexes	Répertoriez les index d'une base de données dans votre projet Firebase. La commande utilise l'indicateur suivant: --database DATABASE_ID pour spécifier le nom de la base de données pour laquelle répertorier les index. Si ce n'est pas le cas, les index sont répertoriés pour la base de données par défaut.
firestore:delete	Supprime les documents de la base de données du projet actif. À l'aide de la CLI, vous pouvez supprimer de manière récursive tous les documents d'une collection. Notez que la suppression de données Cloud Firestore à l'aide de la CLI entraîne des coûts de lecture et de suppression. Pour en savoir plus, consultez la page Comprendre la facturation Cloud Firestore. La commande utilise l'indicateur suivant: --database DATABASE_ID pour spécifier le nom de la base de données dans laquelle les documents sont supprimés. Si aucune valeur n'est spécifiée, les documents sont supprimés de la base de données par défaut. Facultatif.

Commandes Cloud Functions for Firebase

Commande	Description
functions:config:clone	Il clone l'environnement d'un autre projet dans le projet Firebase actif.
functions:config:get	Récupère les valeurs de configuration existantes des fonctions Cloud Functions du projet actif.
functions:config:set	Stocke les valeurs de configuration de l'environnement d'exécution des fonctions Cloud Functions du projet actif.
functions:config:unset	Supprime les valeurs de la configuration d'exécution du projet actif.
functions:log	Lit les journaux des fonctions Cloud déployées.

Pour en savoir plus, consultez la documentation sur la configuration de l'environnement.

Commandes Crashlytics

Commande	Description
crashlytics:mappingfile:generateid \ --resource-file=PATH/TO/ANDROID_RESOURCE.XML	Génère un ID de fichier de mappage unique dans le fichier de ressource Android (XML) spécifié.
crashlytics:mappingfile:upload \ --app=FIREBASE_APP_ID \ --resource-file=PATH/TO/ANDROID_RESOURCE.XML \ PATH/TO/MAPPING_FILE.TXT	Importe un fichier de mappage (TXT) compatible avec ProGuard pour cette application et l'associe à l'ID de fichier de mappage déclaré dans le fichier XML de ressources Android spécifié.
crashlytics:symbols:upload \ --app=FIREBASE_APP_ID \ PATH/TO/SYMBOLS	Génère un fichier de symboles compatible avec Crashlytics pour les plantages de la bibliothèque native sur Android et l'importe sur les serveurs Firebase.

Commandes des extensions

Commande	Description
ext	Affiche des informations sur l'utilisation des commandes Extensions Firebase. Répertorie les instances d'extension installées dans le projet actif.
ext:configurer \ EXTENSION_INSTANCE_ID	Permet de reconfigurer les valeurs de paramètre d'une instance d'extension dans le fichier manifeste d'extension.
ext:info \ PUBLISHER_ID/EXTENSION_ID	Affiche des informations détaillées sur une extension.
ext:installation \ PUBLISHER_ID/EXTENSION_ID	Ajoute une instance d'extension au fichier manifeste d'extension.
ext:liste	Répertorie toutes les instances d'extension installées dans un projet Firebase. Affiche l'ID d'instance pour chaque extension.
ext:désinstaller \ EXTENSION_INSTANCE_ID	Supprime une instance d'extension de votre fichier manifeste d'extension.
ext:mise à jour \ EXTENSION_INSTANCE_ID	Met à jour une instance d'extension vers la dernière version dans votre fichier manifeste d'extension.
ext:export	exporte toutes les instances d'extension installées de votre projet vers le fichier manifeste d'extension ;

Commandes de l'éditeur des extensions

Commande	Description
ext:dev:init	Initialise un codebase squelette pour une nouvelle extension dans le répertoire actuel.
ext:dev:list \ PUBLISHER_ID	Affiche la liste de toutes les extensions importées par un éditeur.
ext:dev:register	Enregistre un projet Firebase en tant que projet d'éditeur d'extensions.
ext:dev:abandonner \ PUBLISHER_ID/EXTENSION_ID\ VERSION_PREDICATE	Abandon les versions d'extension qui correspondent au prédicat de version. Un prédicat de version peut être une version unique (par exemple, 1.0.0) ou une plage de versions (par exemple, >1.0.0). Si aucun prédicat de version n'est fourni, toutes les versions de cette extension sont obsolètes.
ext:dev:undeprecate \ PUBLISHER_ID/EXTENSION_ID \ VERSION_PREDICATE	Rétablit l'abandon des versions d'extension qui correspondent au prédicat de version. Un prédicat de version peut être une version unique (par exemple, 1.0.0) ou une plage de versions (par exemple, >1.0.0). Si aucun prédicat de version n'est fourni, toutes les versions de cette extension sont annulées.
ext:dev:importation \ PUBLISHER_ID/EXTENSION_ID	Importe une nouvelle version d'une extension.
ext:dev:usage \ PUBLISHER_ID	Affiche le nombre d'installations et les métriques d'utilisation des extensions importées par un éditeur.

Commandes d'hébergement

Commande	Description
hosting:disable	Arrête de diffuser le trafic Firebase Hosting pour le projet Firebase actif. L'URL d'hébergement de votre projet affichera le message "Site introuvable" après l'exécution de cette commande.
Gestion des sites Hosting
firebase Hosting:sites:create \ SITE_ID	Crée un site Hosting dans le projet Firebase actif à l'aide du SITE_ID spécifié (Facultatif) Spécifiez une application Web Firebase existante à associer au nouveau site en transmettant l'indicateur suivant : --app FIREBASE_APP_ID
firebase Hosting:sites:delete \ SITE_ID	Supprime le site Hosting spécifié La CLI affiche un message de confirmation avant de supprimer le site. (Facultatif) Ignorez l'invite de confirmation en transmettant les options suivantes: -f ou --force.
firebase enterprise:sites:get \ SITE_ID	Récupère les informations sur le site Hosting spécifié.
firebase Hosting:sites:list	Répertorie tous les sites Hosting pour le projet Firebase actif
Gestion des canaux de prévisualisation
firebase Hosting:channel:create \ CHANNEL_ID	Crée un canal de prévisualisation sur le site Hosting par défaut à l'aide du CHANNEL_ID spécifié. Cette commande ne se déploie pas sur le canal.
firebase hosts:channel:delete \ CHANNEL_ID	Supprime la chaîne de prévisualisation spécifiée. Vous ne pouvez pas supprimer la chaîne en direct d'un site.
firebase enterprise:channel:deploy \ CHANNEL_ID	Déploiement de votre contenu et de votre configuration Hosting sur le canal d'aperçu spécifié Si le canal de prévisualisation n'existe pas encore, cette commande crée le canal sur le site Hosting par défaut avant de le déployer sur le canal.
firebase Hosting:channel:list	Répertorie toutes les chaînes (y compris la chaîne "en direct") du site Hosting par défaut
firebase Hosting:channel:open \ CHANNEL_ID	Ouvre l'URL de la chaîne spécifiée dans un navigateur ou renvoie l'URL s'il n'est pas possible de l'ouvrir dans un navigateur
Clonage de versions
firebase Hosting:clone \ SOURCE_SITE_ID:SOURCE_CHANNEL_ID\ TARGET_SITE_ID:TARGET_CHANNEL_ID	Il clone la dernière version déployée sur le canal "source" spécifié vers le canal "cible" spécifié. Cette commande est également déployée sur le canal "cible" spécifié. Si le canal "cible" n'existe pas encore, cette commande crée un canal de prévisualisation dans le site Hosting "cible" avant de la déployer sur le canal.
firebase Hosting:clone \ SOURCE_SITE_ID:@VERSION_ID\ TARGET_SITE_ID:TARGET_CHANNEL_ID	Il clone la version spécifiée dans la version "cible" spécifiée. Cette commande est également déployée sur le canal "cible" spécifié. Si le canal "cible" n'existe pas encore, cette commande crée un canal de prévisualisation dans le site Hosting "cible" avant de la déployer sur le canal. Vous trouverez le VERSION_ID dans le tableau de bord d'hébergement de la console Firebase.

Commandes Realtime Database

Notez que vous pouvez créer votre instance Realtime Database initiale par défaut dans la console Firebase, ou à l'aide du workflow firebase init général ou du flux firebase init database spécifique.

Une fois les instances créées, vous pouvez les gérer comme indiqué dans la section Gérer plusieurs instances Realtime Database.

Commande	Description
database:get	Récupère les données de la base de données du projet actif et les affiche au format JSON. Accepte l'interrogation de données indexées.
database:instances:create	Crée une instance de base de données avec le nom d'instance spécifié. Accepte l'option --location pour créer une base de données dans une région spécifiée. Pour connaître les noms des régions à utiliser avec cette option, consultez la section Sélectionner des emplacements pour votre projet. Si aucune instance de base de données n'existe pour le projet en cours, vous êtes invité à exécuter le flux firebase init pour créer une instance.
database:instances:list	Répertoriez toutes les instances de base de données associées à ce projet. Accepte l'option --location pour répertorier les bases de données dans une région spécifiée. Pour connaître les noms des régions à utiliser avec cette option, consultez la section Sélectionner des emplacements pour votre projet.
database:profile	Crée un profil des opérations sur la base de données du projet actif. Pour en savoir plus, consultez la section Types d'opérations de Realtime Database.
database:push	Transfère les nouvelles données vers une liste à un emplacement spécifié dans la base de données du projet actif. Prend l'entrée d'un fichier, d'un fichier STDIN ou d'un argument de ligne de commande.
database:remove	Supprime toutes les données d'un emplacement spécifié dans la base de données du projet actif.
database:set	Remplace toutes les données à un emplacement spécifié dans la base de données du projet actif. Prend l'entrée d'un fichier, d'un fichier STDIN ou d'un argument de ligne de commande.
database:update (base de données:mise à jour)	Effectue une mise à jour partielle à un emplacement spécifié dans la base de données du projet actif. Prend l'entrée d'un fichier, d'un fichier STDIN ou d'un argument de ligne de commande.

Commandes Remote Config

Commande	Description
remoteconfig:versions:list \ --limit NUMBER_OF_VERSIONS	Liste les dix versions les plus récentes du modèle. Spécifiez 0 pour renvoyer toutes les versions existantes ou transmettez éventuellement l'option --limit pour limiter le nombre de versions renvoyées.
remoteconfig:get \ --v, version_number VERSION_NUMBER --o, sortie FILENAME	Récupère le modèle par version (par défaut, la dernière version) et génère les groupes de paramètres, les paramètres, les noms et la version de condition dans une table. Vous pouvez éventuellement écrire la sortie dans un fichier spécifié avec -o, FILENAME.
remoteconfig:rollback \ --v, version_number VERSION_NUMBER --force	Effectue un rollback du modèle Remote Config vers un numéro de version précédent spécifié ou applique par défaut la version précédente immédiate (version actuelle -1). Si --force n'est pas transmis, vous êtes invité à indiquer Y/N avant de procéder au rollback.