Referencia de Firebase CLI

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

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

Configura o actualiza la CLI

Instala la CLI de Firebase.

Puedes instalar Firebase CLI con un método que coincida con tu sistema operativo, nivel de experiencia o caso de uso. Sin importar cómo la instales, tendrás acceso a las mismas funciones y al comando firebase.

Windows macOS Linux

Windows

Puedes instalar Firebase CLI para Windows con una de las siguientes opciones:

macOS o Linux

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

Accede y prueba Firebase CLI

Debes autenticarte después de instalar la CLI. Para confirmar la autenticación, puedes enumerar tus proyectos de Firebase.

1. Accede a Firebase con tu Cuenta de Google ejecutando el siguiente comando:

   firebase login

   Este comando conecta tu máquina local a Firebase y te otorga acceso a los proyectos de Firebase.

2. Enumera tus proyectos de Firebase para probar que se instaló correctamente la CLI y que accediste a tu cuenta. Ejecuta el siguiente comando:

   firebase projects:list

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

Actualiza a la versión más reciente de la CLI

En general, se recomienda usar la versión más actualizada de Firebase CLI.

La forma de actualizar la versión de la CLI depende del sistema operativo y de cómo instalaste esta herramienta.

Usa la CLI con sistemas de CI

Firebase CLI requiere un navegador para completar la autenticación, pero esta herramienta es totalmente compatible con la IC y otros entornos sin interfaz gráfica.

1. Instala Firebase CLI en una máquina que cuente con un navegador.

2. Para iniciar el proceso de acceso, ejecuta el siguiente comando:

   firebase login:ci

3. Visita la URL proporcionada y, luego, accede con una Cuenta de Google.

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

5. Almacena el token de salida de forma segura pero accesible en tu sistema de CI.

6. Úsalo cuando ejecutes comandos firebase. Puedes utilizar cualquiera de estas dos opciones:

   • Opción 1: Almacena el token como la variable de entorno FIREBASE_TOKEN. El sistema usará el token automáticamente.

   • Opción 2: Ejecuta todos los comandos firebase con la marca --token TOKEN en tu sistema de CI.
     El orden de prioridad para la carga de tokens es el siguiente: marca, variable de entorno y proyecto de Firebase deseado.

Inicializa un proyecto de Firebase

Muchas de las tareas comunes que se realizan con la CLI, como implementarla en un proyecto de Firebase, requieren un directorio del proyecto. Este directorio se establece con el comando firebase init. Por lo general, el directorio del proyecto es el mismo que la raíz del control de fuente y, después de ejecutar firebase init, este contendrá un archivo de configuración firebase.json.

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

firebase init

El comando firebase init te guía paso a paso en la configuración del directorio del proyecto y algunos productos de Firebase. Durante la inicialización del proyecto, Firebase CLI te solicita lo siguiente:

• Que selecciones los productos de Firebase que quieras configurar en un proyecto de Firebase.

  Hacer esto permite establecer la configuración de archivos específicos de los productos seleccionados. Para obtener más detalles sobre estas configuraciones, consulta la documentación de cada producto (por ejemplo, Hosting). Ten en cuenta que siempre puedes ejecutar firebase init más tarde para configurar más productos de Firebase.

• Que selecciones un proyecto predeterminado de Firebase.

  En este paso, se asocia el directorio del proyecto actual con un proyecto de Firebase, de modo que los comandos específicos del proyecto (como firebase deploy) se ejecuten en relación con el proyecto de Firebase correcto.

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

Al final de la inicialización, Firebase crea y agrega automáticamente dos archivos a la raíz del directorio local de apps:

• Un archivo de configuración firebase.json que contiene la configuración del proyecto

• Un archivo .firebaserc en el que se almacenan los alias del proyecto

El archivo firebase.json

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

El archivo firebase.json es obligatorio para implementar recursos con Firebase CLI, ya que especifica qué archivos y qué configuración del directorio del proyecto se deben implementar en el proyecto de Firebase. Como algunas opciones de configuración se pueden definir en el directorio del proyecto o en Firebase console, asegúrate 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, en el caso de otros servicios de Firebase que pueden implementarse con Firebase CLI, el comando firebase init crea archivos específicos en los que puedes definir la configuración de esos servicios, como un archivo index.js para Cloud Functions. También puedes configurar hooks previos o posteriores a la implementación en el archivo firebase.json.

El siguiente es un archivo firebase.json de ejemplo que contiene la configuración predeterminada si seleccionas Firebase Hosting, Cloud Firestore y Cloud Functions for Firebase (con las opciones de source y lint de TypeScript 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 la marca --config PATH para especificar un archivo de configuración alternativo.

Configuración de varias bases de datos de Cloud Firestore

Cuando ejecutes 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 tu proyecto contiene varias bases de datos de Cloud Firestore, edita tu archivo firebase.json para asociar diferentes Cloud Firestore Security Rules y archivos fuente de índice de base de datos a cada base de datos. Modifica el archivo con un array 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 ignorarán 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 ignorarán. Esto impide la implementación en los archivos externos de backend que podrían aumentar el tamaño de los datos de la implementación.

La lista de archivos ignorados de forma predeterminada, que se muestra en formato JSON, es la siguiente:

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

Si agregas tus propios valores personalizados para ignore en firebase.json, asegúrate de mantener (o agregar, si es que no está), la lista de archivos que se mostró anteriormente.

Administra alias de proyectos

Puedes asociar varios proyectos de Firebase con un mismo directorio de proyecto. Por ejemplo, recomendamos que uses un proyecto de Firebase para la etapa de pruebas y otro para la producción. Si usas diferentes entornos de proyectos, podrás verificar los cambios antes de implementarlos en la producción. El comando firebase use te permite cambiar de alias, además de crear otros nuevos.

Agrega un alias de proyecto

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

firebase use --add

Este comando requiere que selecciones otro proyecto de Firebase y le asignes un alias definido. Las definiciones de alias se escriben en un archivo .firebaserc dentro del directorio del proyecto.

Usa alias de proyectos

Si quieres usar alias de proyectos de Firebase definidos, ejecuta cualquiera de los siguientes comandos en el directorio del proyecto.

Puedes usar la marca --project con cualquier comando de la CLI para anular el proyecto activo en ese momento. Por ejemplo, puedes hacer que la CLI se ejecute en un proyecto de Firebase al que le asignaste el alias staging. Si quieres ejecutar un solo comando en un proyecto de Firebase al que le asignaste el alias prod, podrás ejecutar, por ejemplo, firebase deploy --project=prod.

Control de código fuente y alias de proyectos

En general, debes registrar el archivo .firebaserc en el control de código fuente para que tu equipo pueda compartir alias de proyectos. Sin embargo, en el caso de los proyectos de código abierto o las plantillas de inicio, en general, no debes registrarlos en el archivo .firebaserc.

Si tienes un proyecto de desarrollo que solo tú usas, puedes pasar la marca --project con cada comando o ejecutar firebase use PROJECT_ID sin definir un alias para el proyecto de Firebase.

Publica y prueba tu proyecto de Firebase en forma local

Puedes ver y probar tu proyecto de Firebase en las URL alojadas localmente antes de implementarlo en producción. Si solo quieres probar algunas funciones, puedes usar una lista de elementos separados por comas en una marca del comando firebase serve.

Ejecuta el siguiente comando desde la raíz del directorio del proyecto local si quieres realizar alguna de estas tareas:

• Ver el contenido estático de la app alojada en Firebase
• Usar Cloud Functions para generar contenido dinámico para Firebase Hosting y usar las funciones de HTTP de producción (implementadas) para emular Hosting en una URL local

firebase serve --only hosting

Emula el proyecto con funciones de HTTP locales

Ejecuta cualquiera de los siguientes comandos desde el directorio del proyecto para emular el proyecto con funciones locales de HTTP.

• A fin de emular funciones de HTTP y alojamiento para pruebas en URL locales, usa cualquiera de los siguientes comandos:

  firebase serve

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

• Para emular solo funciones de HTTP, usa el siguiente comando:

  firebase serve --only functions

Realiza pruebas desde otros dispositivos locales

De forma predeterminada, firebase serve solo responde a las solicitudes de localhost. Esto significa que podrás acceder al contenido alojado mediante el navegador web de tu computadora, pero no desde otros dispositivos de la red. Usa la marca --host para realizar pruebas en otros dispositivos locales, como se indica a continuación:

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

Implementa en un proyecto de Firebase

Firebase CLI administra la implementación del código y los recursos en tu proyecto de Firebase. Esto incluye lo siguiente:

• Versiones nuevas de tus sitios de Firebase Hosting
• Cloud Functions for Firebase nuevas, actualizadas o existentes
• Esquemas y conectores nuevos o actualizados para Firebase Data Connect
• Reglas para Firebase Realtime Database
• Reglas para Cloud Storage for Firebase
• Reglas para Cloud Firestore
• Índices para Cloud Firestore

Para implementar un proyecto de Firebase, ejecuta el siguiente comando desde el directorio de tu proyecto:

firebase deploy

De manera opcional, puedes agregar un comentario a cada una de tus implementaciones. Este comentario se mostrará junto con otra información de la implementación en la página Firebase Hosting del proyecto. Por ejemplo:

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

Cuando uses el comando firebase deploy, ten en cuenta lo siguiente:

• Para implementar recursos desde un directorio de proyecto, este debe tener un archivo firebase.json. El comando firebase init lo crea automáticamente.

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

Conflictos de implementación de reglas de seguridad

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

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

Cuotas de implementación

Es posible (aunque poco probable) que excedas una cuota que limite la tasa o el volumen de las operaciones de implementación de Firebase. Por ejemplo, si implementas muchas funciones, podrías recibir un mensaje de error HTTP 429 Quota. Para resolver estos problemas, usa la implementación parcial.

Revierte una implementación

Puedes revertir una implementación de Firebase Hosting en la página de Firebase Hosting de tu proyecto. Para ello, selecciona la acción Revertir en la versión correspondiente.

En este momento, no es posible revertir actualizaciones de reglas de seguridad de Firebase Realtime Database, Cloud Storage for Firebase ni Cloud Firestore.

Implementa servicios de Firebase específicos

Si solo quieres implementar servicios o funciones de Firebase específicos, puedes usar una lista de elementos separados por comas en una marca del 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 la implementación parcial. Los nombres de las marcas corresponden a las claves del archivo de configuración firebase.json.

Implementa funciones específicas

Cuando implementas funciones, puedes indicar algunas de forma específica. Por ejemplo:

firebase deploy --only functions:function1

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

Otra opción es reunir las funciones en grupos de exportación en el archivo /functions/index.js. Agrupar funciones te permite implementar varias de ellas con un solo comando.

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

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

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

En este ejemplo, se incluye un archivo functions/groupB.js aparte que define específicamente groupB. Por ejemplo:

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

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

En este ejemplo, puedes implementar todas las funciones de groupA si ejecutas el siguiente comando desde el directorio de tu proyecto:

firebase deploy --only functions:groupA

O puedes indicar una función específica dentro de un grupo con solo ejecutar el siguiente comando:

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

Borra funciones

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

• Borrar todas las funciones que coincidan con el nombre especificado en todas las regiones:

  firebase functions:delete FUNCTION-1_NAME

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

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

• Borrar más de una función:

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

• Borrar un grupo de funciones especificadas:

  firebase functions:delete GROUP_NAME

• Omitir el mensaje de confirmación:

  firebase functions:delete FUNCTION-1_NAME --force

Configura tareas de secuencia de comandos previas y posteriores a la implementación

Puedes conectar secuencias de comandos de shell al comando firebase deploy para realizar tareas previas a la implementación o posteriores a ella. Por ejemplo, una secuencia de comandos previa a la implementación podría transpilar el código de TypeScript a JavaScript y un hook posterior a la implementación podría notificar a los administradores cuándo se implementa contenido nuevo del sitio en Firebase Hosting.

Para configurar hooks previos a la implementación o posteriores a ella, agrega las secuencias de comandos de Bash al archivo de configuración firebase.json. Puedes definir secuencias de comandos breves directamente en el archivo firebase.json o puedes consultar otros archivos que se encuentren en el directorio de tu proyecto.

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

"hosting": {
  // ...

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

El archivo de la secuencia de comandos messageSlack.sh reside en el directorio del proyecto y es similar al siguiente:

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

Puedes configurar los hooks predeploy y postdeploy para cualquiera de los recursos que puedes implementar. Ten en cuenta que ejecutar firebase deploy activa todas las tareas previas y posteriores a la implementación que se definieron en el archivo firebase.json. Para ejecutar solo aquellas tareas asociadas con un servicio de Firebase específico, usa comandos de implementación parcial.

Los hooks predeploy y postdeploy muestran los flujos estándar de salida y de errores de las secuencias de comandos en la terminal. En caso de error, ten en cuenta lo siguiente:

• Si un hook previo a la implementación no se completa según lo previsto, la implementación se cancela.
• Si la implementación falla por cualquier motivo, los hooks previos a la implementación no se activan.

Variables de entorno

Las siguientes variables de entorno están disponibles dentro de las secuencias de comandos que se ejecutan en los hooks previos a la implementación y posteriores a ella:

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

Administra varias instancias de Realtime Database

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

Sin embargo, puedes interactuar con una instancia no predeterminada de la base de datos mediante la marca --instance DATABASE_NAME. Los siguientes comandos admiten la marca --instance:

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

Referencia de comandos

Comandos administrativos de la CLI

Comandos de administración de proyectos

Implementación y desarrollo local

Estos comandos te permiten implementar y, además, interactuar con tu sitio de Firebase Hosting.

Comandos App Distribution

Comandos App Hosting

Comandos de Authentication (administración de usuarios)

Comandos Cloud Firestore

Comandos Cloud Functions for Firebase

Consulta la documentación de la configuración del entorno para obtener más detalles.

Comandos Crashlytics

Comandos Data Connect

Estos comandos y sus casos de uso se describen con más detalle en la guía de referencia de la CLI de Data Connect.

Comandos Extensions

Comandos del publicador de Extensions

Comandos Hosting

Comandos Realtime Database

Ten en cuenta que puedes crear tu instancia inicial y predeterminada de Realtime Database en Firebase console o con el flujo de trabajo general firebase init o el flujo firebase init database específico.

Una vez que se creen las instancias, puedes administrarlas como se describe en Administra varias instancias de Realtime Database.

Comandos Remote Config