Referencia de Firebase CLI

Firebase CLI ( GitHub ) proporciona una variedad de herramientas para administrar, ver e implementar en proyectos de Firebase.

Antes de usar Firebase CLI, configura un proyecto de Firebase .

Configurar o actualizar la CLI

Instale la CLI de Firebase

Puedes instalar Firebase CLI usando un método que coincida con tu sistema operativo, nivel de experiencia y/o caso de uso. Independientemente de cómo instale la CLI, tendrá acceso a la misma funcionalidad y al comando firebase .

WindowsMacOSLinux _ _

ventanas

Puede instalar Firebase CLI para Windows usando una de las siguientes opciones:

macOS o Linux

Puedes instalar Firebase CLI para macOS o Linux usando una de las siguientes opciones:

Inicie sesión y pruebe Firebase CLI

Después de instalar la CLI, debe autenticarse. Luego puede confirmar la autenticación enumerando sus proyectos de Firebase.

1. Inicie sesión en Firebase con su cuenta de Google ejecutando el siguiente comando:

   firebase login

   Este comando conecta su máquina local a Firebase y le otorga acceso a sus proyectos de Firebase.

2. Pruebe que la CLI esté instalada correctamente y acceda a su cuenta enumerando sus proyectos de Firebase. Ejecute el siguiente comando:

   firebase projects:list

   La lista mostrada debe ser la misma que la de los proyectos de Firebase enumerados en Firebase console .

Actualizar a la última versión de CLI

Generalmente, desea utilizar la versión más actualizada de Firebase CLI.

La forma de actualizar la versión de la CLI depende de su sistema operativo y de cómo instaló la CLI.

Utilice la CLI con sistemas CI

Firebase CLI requiere un navegador para completar la autenticación, pero la CLI es totalmente compatible con CI y otros entornos sin cabeza.

1. En una máquina con un navegador, instale Firebase CLI .

2. Inicie el proceso de inicio de sesión ejecutando el siguiente comando:

   firebase login:ci

3. Visite la URL proporcionada y luego inicie sesión con una cuenta de Google.

4. Imprima un nuevo token de actualización . La sesión CLI actual no se verá afectada.

5. Guarde el token de salida de forma segura pero accesible en su sistema de CI.

6. Utilice este token cuando ejecute comandos firebase . Puede utilizar cualquiera de las siguientes dos opciones:

   • Opción 1: almacenar el token como la variable de entorno FIREBASE_TOKEN . Su sistema utilizará automáticamente el token.

   • Opción 2: ejecute todos los comandos firebase con el indicador --token TOKEN en su sistema CI.
     Este es el orden de precedencia para la carga de tokens: bandera, variable de entorno, proyecto de Firebase deseado.

Inicializar un proyecto de Firebase

Muchas tareas comunes realizadas con la CLI, como la implementación en un proyecto de Firebase, requieren un directorio de proyecto . Estableces un directorio de proyecto usando el comando firebase init . Un directorio de proyecto suele ser el mismo directorio que la raíz de control de código fuente y, después de ejecutar firebase init , el directorio contiene un archivo de configuración firebase.json .

Para inicializar un nuevo proyecto de Firebase, ejecuta el siguiente comando desde el directorio de tu aplicación:

firebase init

El comando firebase init lo guía a través de la configuración del directorio de su proyecto y algunos productos de Firebase. Durante la inicialización del proyecto, Firebase CLI le solicita que complete las siguientes tareas:

• Seleccione los productos de Firebase que desee para configurar en su proyecto de Firebase.

  Este paso le solicita que establezca configuraciones para archivos específicos para los productos seleccionados. Para obtener más detalles sobre estas configuraciones, consulte la documentación del producto específico (por ejemplo, Hosting ). Tenga en cuenta que siempre puede ejecutar firebase init más adelante para configurar más productos de Firebase.

• Seleccione un proyecto de Firebase predeterminado.

  Este paso asocia el directorio del proyecto actual con un proyecto de Firebase para que los comandos específicos del proyecto (como firebase deploy ) se ejecuten en el proyecto de Firebase apropiado.

  También es posible asociar varios proyectos de Firebase (como un proyecto de prueba y un proyecto de producción) con el mismo directorio de proyectos.

Al final de la inicialización, Firebase crea automáticamente los dos archivos siguientes en la raíz del directorio de su aplicación local:

• Un archivo de configuración firebase.json que enumera la configuración de su proyecto.

• Un archivo .firebaserc que almacena los alias de su proyecto.

El archivo firebase.json

El comando firebase init crea un archivo de configuración firebase.json en la raíz del directorio de su proyecto.

El archivo firebase.json es necesario para implementar activos con Firebase CLI porque especifica qué archivos y configuraciones del directorio de su proyecto se implementan en su proyecto de Firebase. Dado que algunas configuraciones se pueden definir en el directorio de su proyecto o en Firebase console, asegúrese de resolver cualquier posible conflicto de implementación .

Puedes configurar la mayoría de las opciones de Firebase Hosting directamente en el archivo firebase.json . Sin embargo, para otros servicios de Firebase que se pueden implementar con Firebase CLI , el comando firebase init crea archivos específicos donde puede definir configuraciones para esos servicios, como un archivo index.js para Cloud Functions. También puede configurar enlaces previos o posteriores a la implementación en el archivo firebase.json .

El siguiente es un ejemplo de archivo firebase.json con configuración predeterminada si selecciona Firebase Hosting, Cloud Firestore y Cloud Functions para Firebase (con el origen de TypeScript y las opciones de lint seleccionadas) durante la inicialización.

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

Si bien firebase.json se usa de forma predeterminada, puedes pasar el indicador --config PATH para especificar un archivo de configuración alternativo.

Configuración para múltiples bases de datos de Cloud Firestore

Cuando ejecutas firebase init , tu archivo firebase.json contendrá una única clave firestore correspondiente a la base de datos predeterminada de tu proyecto, como se muestra arriba.

Si su proyecto contiene varias bases de datos de Cloud Firestore, edite su archivo firebase.json para asociar diferentes reglas de seguridad de Cloud Firestore y archivos fuente de índice de base de datos con cada base de datos. Modifique el archivo con una matriz JSON, con una entrada para cada base de datos.

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

Archivos de Cloud Functions que se deben ignorar durante la implementación

En el momento de la implementación de la función, la CLI especifica automáticamente una lista de archivos en el directorio functions que se deben ignorar. Esto evita la implementación en el backend de archivos extraños que podrían aumentar el tamaño de los datos de su implementación.

La lista de archivos ignorados por defecto, que se muestra en formato JSON, es:

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

Si agrega sus propios valores personalizados para ignore en firebase.json , asegúrese de mantener (o agregar, si falta) la lista de archivos que se muestra arriba.

Administrar alias de proyectos

Puedes asociar varios proyectos de Firebase con el mismo directorio de proyectos. Por ejemplo, es posible que desees utilizar un proyecto de Firebase para la preparación y otro para la producción. Al utilizar diferentes entornos de proyecto, puede verificar los cambios antes de implementarlos en producción. El comando firebase use le permite cambiar entre alias y crear nuevos alias.

Agregar un alias de proyecto

Cuando seleccionas un proyecto de Firebase durante la inicialización del proyecto , al proyecto se le asigna automáticamente el alias default . Sin embargo, para permitir que los comandos específicos del proyecto se ejecuten en un proyecto de Firebase diferente pero aún usen el mismo directorio del proyecto, ejecute el siguiente comando desde el directorio de su proyecto:

firebase use --add

Este comando le solicita que seleccione otro proyecto de Firebase y le asigne el proyecto como alias. Las asignaciones de alias se escriben en un archivo .firebaserc dentro del directorio de su proyecto.

Usar alias de proyecto

Para usar alias de proyecto de Firebase asignados, ejecute cualquiera de los siguientes comandos desde el directorio de su proyecto.

Puede anular lo que se está utilizando como proyecto actualmente activo pasando el indicador --project con cualquier comando CLI. Como ejemplo: puede configurar su CLI para que se ejecute en un proyecto de Firebase al que le haya asignado el alias staging . Si desea ejecutar un solo comando en el proyecto de Firebase al que le asignó el alias prod , puede ejecutar, por ejemplo, firebase deploy --project=prod .

Control de fuente y alias de proyecto.

En general, debes registrar tu archivo .firebaserc en el control de código fuente para permitir que tu equipo comparta los alias del proyecto. Sin embargo, para proyectos de código abierto o plantillas de inicio, generalmente no debes registrar tu archivo .firebaserc .

Si tiene un proyecto de desarrollo que es para su uso exclusivo, puede pasar el indicador --project con cada comando o ejecutar firebase use PROJECT_ID sin asignar un alias al proyecto de Firebase.

Sirve y prueba tu proyecto de Firebase localmente

Puedes ver y probar tu proyecto de Firebase en URL alojadas localmente antes de implementarlo en producción. Si solo desea probar funciones seleccionadas, puede usar una lista separada por comas en una bandera en el comando firebase serve .

Ejecute el siguiente comando desde la raíz del directorio de su proyecto local si desea realizar cualquiera de las siguientes tareas:

• Vea el contenido estático de su aplicación alojada en Firebase.
• Utilice Cloud Functions para generar contenido dinámico para Firebase Hosting y desee utilizar sus funciones HTTP de producción (implementadas) para emular Hosting en una URL local.

firebase serve --only hosting

Emule su proyecto usando funciones HTTP locales

Ejecute cualquiera de los siguientes comandos desde el directorio de su proyecto para emular su proyecto utilizando funciones HTTP locales .

• Para emular funciones HTTP y alojamiento para realizar pruebas en URL locales, utilice cualquiera de los siguientes comandos:

  firebase serve

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

• Para emular funciones HTTP únicamente, utilice el siguiente comando:

  firebase serve --only functions

Prueba desde otros dispositivos locales

De forma predeterminada, firebase serve solo responde a solicitudes de localhost . Esto significa que podrá acceder a su contenido alojado desde el navegador web de su computadora, pero no desde otros dispositivos en su red. Si desea realizar la prueba desde otros dispositivos locales, utilice el indicador --host , así:

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

Implementar en un proyecto de Firebase

Firebase CLI administra la implementación de código y recursos en su proyecto de Firebase, incluidos:

• Nuevos lanzamientos de sus sitios de Firebase Hosting
• Funciones de nube nuevas, actualizadas o existentes para Firebase
• Reglas para la base de datos en tiempo real de Firebase
• Reglas de almacenamiento en la nube para Firebase
• Reglas para Cloud Firestore
• Índices para Cloud Firestore

Para implementar en un proyecto de Firebase, ejecute el siguiente comando desde el directorio de su proyecto:

firebase deploy

Opcionalmente, puede agregar un comentario a cada una de sus implementaciones. Este comentario se mostrará con el resto de la información de implementación en la página Firebase Hosting de su proyecto. Por ejemplo:

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

Cuando utilice el comando firebase deploy , tenga en cuenta lo siguiente:

• Para implementar recursos desde un directorio de proyecto, el directorio del proyecto debe tener un archivo firebase.json . Este archivo se crea automáticamente mediante el comando firebase init .

• De forma predeterminada, firebase deploy crea una versión para todos los recursos implementables en el directorio de su proyecto. Para implementar funciones o servicios específicos de Firebase, utiliza la implementación parcial .

Conflictos de implementación de reglas de seguridad

Para Firebase Realtime Database, Cloud Storage for Firebase y Cloud Firestore, puedes definir reglas de seguridad en el directorio de tu proyecto local o en Firebase console .

Otra opción para evitar conflictos de implementación es utilizar una implementación parcial y definir reglas solo en Firebase console.

Cuotas de implementación

Es posible (aunque poco probable) que superes una cuota que limite la tasa o el volumen de tus operaciones de implementación de Firebase. Por ejemplo, al implementar una gran cantidad de funciones, es posible que reciba un mensaje de error HTTP 429 Quota . Para resolver estos problemas, intente utilizar la implementación parcial .

Revertir una implementación

Puedes revertir una implementación de Firebase Hosting desde la página Firebase Hosting de tu proyecto seleccionando la acción Revertir para la versión deseada.

Actualmente, no es posible revertir versiones de reglas de seguridad para Firebase Realtime Database, Cloud Storage for Firebase o Cloud Firestore.

Implementar servicios específicos de Firebase

Si solo desea implementar funciones o servicios específicos de Firebase, puede usar una lista separada por comas en una marca en el comando firebase deploy . Por ejemplo, el siguiente comando implementa contenido de Firebase Hosting y reglas de seguridad de Cloud Storage.

firebase deploy --only hosting,storage

La siguiente tabla enumera los servicios y funciones disponibles para implementación parcial. Los nombres en las banderas corresponden a las claves en su archivo de configuración firebase.json .

Implementar funciones específicas

Al implementar funciones, puede apuntar a funciones específicas. Por ejemplo:

firebase deploy --only functions:function1

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

Otra opción es agrupar funciones en grupos de exportación en su archivo /functions/index.js . La agrupación de funciones le permite implementar múltiples funciones usando un solo comando.

Por ejemplo, puede escribir las siguientes funciones para definir un groupA y un groupB :

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

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

En este ejemplo, un archivo functions/groupB.js separado contiene funciones adicionales que definen específicamente las funciones en groupB . Por ejemplo:

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

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

En este ejemplo, puede implementar todas las funciones groupA ejecutando el siguiente comando desde el directorio de su proyecto:

firebase deploy --only functions:groupA

O puede apuntar a una función específica dentro de un grupo ejecutando el siguiente comando:

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

Eliminar funciones

Firebase CLI admite los siguientes comandos y opciones para eliminar funciones implementadas previamente:

• Elimina todas las funciones que coinciden con el nombre especificado en todas las regiones:

  firebase functions:delete FUNCTION-1_NAME

• Elimina una función especificada que se ejecuta en una región no predeterminada:

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

• Elimina más de una función:

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

• Elimina un grupo de funciones específico:

  firebase functions:delete GROUP_NAME

• Omite el mensaje de confirmación:

  firebase functions:delete FUNCTION-1_NAME --force

Configurar tareas con script previas y posteriores a la implementación

Puede conectar scripts de shell al comando firebase deploy para realizar tareas previas o posteriores a la implementación. Por ejemplo, una secuencia de comandos previa a la implementación podría transpilar código TypeScript a JavaScript, y un enlace posterior a la implementación podría notificar a los administradores sobre las implementaciones de contenido nuevo del sitio en Firebase Hosting.

Para configurar enlaces previos o posteriores a la implementación, agregue scripts bash a su archivo de configuración firebase.json . Puede definir scripts breves directamente en el archivo firebase.json o puede hacer referencia a otros archivos que se encuentran en el directorio de su proyecto.

Por ejemplo, la siguiente secuencia de comandos es la expresión firebase.json para una tarea posterior a la implementación que envía un mensaje de Slack tras una implementación exitosa en Firebase Hosting.

"hosting": {
  // ...

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

El archivo de script messageSlack.sh reside en el directorio del proyecto y tiene este aspecto:

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

Puede configurar enlaces predeploy y postdeploy para cualquiera de los activos que puede implementar . Tenga en cuenta que la ejecución firebase deploy activa todas las tareas previas y posteriores a la implementación definidas en su archivo firebase.json . Para ejecutar solo aquellas tareas asociadas con un servicio de Firebase específico, use comandos de implementación parcial .

Tanto los ganchos predeploy como los postdeploy imprimen la salida estándar y los flujos de error de los scripts en la terminal. Para casos de falla, tenga en cuenta lo siguiente:

• Si un enlace previo a la implementación no se completa como se esperaba, se cancela la implementación.
• Si la implementación falla por algún motivo, los enlaces posteriores a la implementación no se activan.

Variables de entorno

Dentro de los scripts que se ejecutan en los enlaces previos y posteriores a la implementación, están disponibles las siguientes variables de entorno:

• $GCLOUD_PROJECT : ID del proyecto activo
• $PROJECT_DIR : el directorio raíz que contiene el archivo firebase.json
• $RESOURCE_DIR : (Solo para scripts hosting y functions ) La ubicación del directorio que contiene los recursos de Hosting o Cloud Functions que se implementarán

Administrar múltiples instancias de Realtime Database

Un proyecto de Firebase puede tener varias instancias de Firebase Realtime Database . De forma predeterminada, los comandos CLI interactúan con su instancia de base de datos predeterminada .

Sin embargo, puede interactuar con una instancia de base de datos no predeterminada utilizando el --instance DATABASE_NAME . Los siguientes comandos admiten el indicador --instance :

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

Referencia de comando

Comandos administrativos CLI

Comandos de gestión de proyectos

Despliegue y desarrollo local

Estos comandos te permiten implementar e interactuar con tu sitio de Firebase Hosting.

Comandos de distribución de aplicaciones

Comandos de autenticación (administración de usuarios)

Comandos de Cloud Firestore

Funciones de nube para comandos de Firebase

Para obtener más información, consulte la documentación de configuración del entorno .

Comandos de Crashlytics

Comandos de extensiones

Comandos del editor de extensiones

Comandos de alojamiento

Comandos de bases de datos en tiempo real

Tenga en cuenta que puede crear su instancia inicial predeterminada de Realtime Database en Firebase console o utilizando el flujo de trabajo general firebase init o el flujo firebase init database específico.

Una vez creadas las instancias, puede administrarlas como se explica en Administrar varias instancias de Realtime Database .

Comandos de configuración remota