Riferimento per l'interfaccia a riga di comando di Firebase

L'interfaccia a riga di comando Firebase (GitHub) fornisce una serie di strumenti per gestire, visualizzare ed eseguire il deployment nei progetti Firebase.

Prima di utilizzare l'interfaccia a riga di comando Firebase, configurare un progetto Firebase.

Configura o aggiorna l'interfaccia a riga di comando

Installa l'interfaccia a riga di comando Firebase

Puoi installare l'interfaccia a riga di comando Firebase utilizzando un metodo adatto al tuo sistema operativo, al tuo livello di esperienza e/o al tuo caso d'uso. Indipendentemente dal modo in cui installi il CLI, hai accesso alle stesse funzionalità e al comando firebase.

Windows macOS Linux

Windows

Puoi installare l'interfaccia a riga di comando Firebase per Windows utilizzando uno dei seguenti metodi opzioni:

macOS o Linux

Puoi installare l'interfaccia a riga di comando Firebase per macOS o Linux utilizzando uno dei le seguenti opzioni:

Accedi e testa l'interfaccia a riga di comando Firebase

Dopo aver installato la CLI, devi autenticarti. Dopodiché puoi confermare autenticazione mediante l'elenco dei progetti Firebase.

1. Accedi a Firebase utilizzando il tuo Account Google eseguendo il seguente comando:

   firebase login

   Questo comando connette la tua macchina locale a Firebase e ti garantisce ai progetti Firebase.

2. Verifica che l'interfaccia a riga di comando sia installata correttamente e che acceda al tuo account elencando i tuoi progetti Firebase. Esegui questo comando:

   firebase projects:list

   L'elenco visualizzato dovrebbe essere uguale a quello dei progetti Firebase elencati nella console Firebase.

Aggiorna all'ultima versione dell'interfaccia a riga di comando

In genere, è consigliabile utilizzare la versione più aggiornata dell'interfaccia a riga di comando Firebase.

La modalità di aggiornamento della versione dell'interfaccia a riga di comando dipende dal sistema operativo e da come installato l'interfaccia a riga di comando.

Utilizzare l'interfaccia a riga di comando con i sistemi CI

La CLI Firebase richiede un browser per completare l'autenticazione, ma è completamente compatibile con CI e altri ambienti headless.

1. Su un computer con un browser, installa l'interfaccia a riga di comando Firebase.

2. Avvia il processo di accesso eseguendo questo comando:

   firebase login:ci

3. Visita l'URL fornito, quindi accedi utilizzando un Account Google.

4. Stampa un nuovo token di aggiornamento. La sessione CLI corrente non sarà interessata.

5. Memorizza il token di output in modo sicuro, ma accessibile, nel sistema CI.

6. Utilizza questo token quando esegui i comandi firebase. Puoi utilizzare uno dei due le due opzioni seguenti:

   • Opzione 1: archivia il token come variabile di ambiente FIREBASE_TOKEN. Il sistema utilizzerà automaticamente il token.

   • Opzione 2: esegui tutti i comandi firebase con il flag --token TOKEN nel sistema CI.
     Questo è l'ordine di precedenza per il caricamento dei token: flag, ambiente del progetto Firebase desiderato.

Inizializzare un progetto Firebase

Molte attività comuni eseguite utilizzando l'interfaccia a riga di comando, come il deployment in un progetto Firebase, richiedono una directory del progetto. Imposta una directory del progetto utilizzando il comando firebase init. Una directory di un progetto è di solito la stessa come root di controllo del codice sorgente e, dopo aver eseguito firebase init, contiene una configurazione firebase.json .

Per inizializzare un nuovo progetto Firebase, esegui il seguente comando dalla directory dell'app:

firebase init

Il comando firebase init ti guida nella configurazione della directory del tuo progetto e alcuni prodotti Firebase. Durante l'inizializzazione del progetto, la CLI Firebase ti chiede di completare le seguenti attività:

• Seleziona i prodotti Firebase che vuoi configurare nel tuo progetto Firebase.

  Questo passaggio richiede di impostare le configurazioni di file specifici per prodotti selezionati. Per ulteriori dettagli su queste configurazioni, consulta la documentazione del prodotto specifico (ad esempio Hosting). Tieni presente che puoi sempre eseguire firebase init in un secondo momento per configurare altri prodotti Firebase.

• Seleziona un progetto Firebase predefinito.

  Questo passaggio associa la directory del progetto corrente a un progetto Firebase in modo che i comandi specifici del progetto (come firebase deploy) vengono eseguiti progetto Firebase appropriato.

  È inoltre possibile associare più progetti Firebase (ad esempio un progetto di gestione temporanea e un progetto di produzione) con lo stesso progetto .

Al termine dell'inizializzazione, Firebase crea automaticamente i due seguenti elementi nella directory principale della directory dell'app locale:

• Un file di configurazione firebase.json che elenca la configurazione del tuo progetto.

• Un file .firebaserc in cui è archiviato il progetto alias.

Il file firebase.json

Il comando firebase init crea un'istanza di configurazione firebase.json nella radice della directory del progetto.

Il file firebase.json è necessario per eseguire il deployment delle risorse con l'interfaccia a riga di comando Firebase perché specifica quali file e impostazioni della directory del progetto vengono eseguiti nel progetto Firebase. Poiché alcune impostazioni possono essere definite in entrambi i progetti o la directory console Firebase, assicurati di risolvere eventuali conflitti di deployment.

Puoi configurare la maggior parte delle opzioni di Firebase Hosting direttamente nel file firebase.json. Tuttavia, per altri Servizi Firebase di cui è possibile eseguire il deployment con l'interfaccia a riga di comando Firebase, Il comando firebase init crea file specifici in cui puoi definire le impostazioni per questi servizi, ad esempio un file index.js per Cloud Functions. Puoi configura anche gli hook di pre-deployment o post-deployment nel file firebase.json.

Di seguito è riportato un esempio di file firebase.json con le impostazioni predefinite se selezioni Firebase Hosting, Cloud Firestore e Cloud Functions for Firebase (con le opzioni di lint e di origine TypeScript selezionate) durante l'inizializzazione.

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

Sebbene firebase.json venga utilizzato per impostazione predefinita, puoi passare il flag --config PATH per specificare un file di configurazione alternativo.

Configurazione per più database Cloud Firestore

Quando esegui firebase init, il file firebase.json conterrà una singola chiave firestore corrispondente al database predefinito del progetto, come mostrato sopra.

Se il progetto contiene più database Cloud Firestore, modifica firebase.json file per associare Cloud Firestore Security Rules e dei file di origine degli indici dei database. Modifica il file con un array JSON con una voce per ogni database.

      "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 file da ignorare durante il deployment

Al momento del deployment della funzione, l'interfaccia a riga di comando specifica automaticamente un elenco di file nella directory functions da ignorare. Questo impedisce il deployment nel backend di file estranei che aumenta la dimensione dei dati del deployment.

L'elenco dei file ignorati per impostazione predefinita, mostrato in formato JSON, è:

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

Se aggiungi i tuoi valori personalizzati per ignore in firebase.json, assicurati di conservare (o aggiungere, se mancante) l'elenco di file mostrato sopra.

Gestisci alias di progetto

Puoi associare più progetti Firebase alla stessa directory di progetto. Ad esempio, potresti utilizzare un progetto Firebase per la gestione temporanea e un altro per la produzione. Utilizzando diversi ambienti di progetto, puoi verificare le modifiche prima del deployment in produzione. Il comando firebase use ti consente di cambiare tra gli alias e creare nuovi alias.

Aggiungere un alias di progetto

Quando selezioni un progetto Firebase durante l'inizializzazione del progetto, al progetto viene assegnato automaticamente l'alias default. Tuttavia, per consentire l'esecuzione di comandi specifici del progetto su un altro progetto Firebase, ma utilizzando comunque la stessa directory del progetto, esegui il seguente comando dalla directory del progetto:

firebase use --add

Questo comando ti chiede di selezionare un altro progetto Firebase e di assegnare progetto come alias. Le assegnazioni di alias vengono scritte in un file .firebaserc all'interno della directory del progetto.

Utilizzare gli alias dei progetti

Per utilizzare gli alias dei progetti Firebase assegnati, esegui uno dei seguenti comandi dalla directory del progetto.

Puoi sostituire il progetto attualmente attivo passando il flag --project con qualsiasi comando CLI. Ad esempio, puoi impostare la CLI in modo che venga eseguita in un progetto Firebase a cui hai assegnato l'alias staging. Se vuoi eseguire un singolo comando sul progetto Firebase a cui hai assegnato l'alias prod, puoi eseguire, ad esempio,firebase deploy --project=prod.

Controllo del codice sorgente e alias dei progetti

In generale, devi controllare il file .firebaserc nel controllo del codice sorgente per consentire al tuo team di condividere gli alias del progetto. Tuttavia, per i progetti open source o per i modelli di partenza, in genere non devi eseguire il check-in del file .firebaserc.

Se hai un progetto di sviluppo solo per uso personale, puoi passare il flag --project con ogni comando o eseguire firebase use PROJECT_ID senza assegnare un alias al progetto Firebase.

Pubblica e testa il progetto Firebase localmente

Puoi visualizzare e testare il tuo progetto Firebase su URL ospitati localmente prima il deployment in produzione. Se vuoi testare solo determinate funzionalità, puoi usare un elenco separato da virgole in un flag nel comando firebase serve.

Esegui questo comando dalla directory radice della directory locale del progetto se vuoi eseguire una delle seguenti attività:

• Visualizza i contenuti statici per l'app ospitata da Firebase.
• Utilizzi Cloud Functions per generare contenuti dinamici per Firebase Hosting e vuoi utilizzare le tue funzioni HTTP di produzione (di cui è stato eseguito il deployment) per emulare Hosting su un URL locale.

firebase serve --only hosting

Emulare il progetto utilizzando funzioni HTTP locali

Esegui uno dei seguenti comandi dalla directory del progetto per emulare il progetto utilizzando funzioni HTTP locali.

• Per emulare le funzioni HTTP e l'hosting per i test su URL locali, utilizza uno dei seguenti comandi:

  firebase serve

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

• Per emulare solo le funzioni HTTP, utilizza il seguente comando:

  firebase serve --only functions

Eseguire il test da altri dispositivi locali

Per impostazione predefinita, firebase serve risponde solo alle richieste provenienti da localhost. Ciò significa che potrai accedere ai contenuti ospitati dal browser web del tuo computer, ma non da altri dispositivi sulla rete. Se vuoi eseguire il test da altri dispositivi locali, utilizza il flag --host, in questo modo:

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

Esegui il deployment in un progetto Firebase

L'interfaccia a riga di comando Firebase gestisce il deployment di codice e asset in Firebase progetto, tra cui:

• Nuove release dei tuoi siti Firebase Hosting
• Cloud Functions for Firebase nuovo, aggiornato o esistente
• Schemi e connettori nuovi o aggiornati per Firebase Data Connect
• Regole per Firebase Realtime Database
• Regole per Cloud Storage for Firebase
• Regole per Cloud Firestore
• Indici per Cloud Firestore

Per eseguire il deployment in un progetto Firebase, esegui questo comando dal progetto directory:

firebase deploy

Facoltativamente, puoi aggiungere un commento a ogni implementazione. Questo commento verrà visualizzato insieme alle altre informazioni di deployment nella Firebase Hosting pagina del progetto. Ad esempio:

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

Quando utilizzi il comando firebase deploy, tieni presente quanto segue:

• Per eseguire il deployment delle risorse da una directory di progetto, la directory del progetto deve contenere un file firebase.json. Questo file è creato automaticamente per te Comando firebase init.

• Per impostazione predefinita, firebase deploy crea una release per tutte le risorse di cui è possibile eseguire il deployment nella directory del progetto. Per eseguire il deployment di funzionalità o servizi Firebase specifici, utilizza il deployment parziale.

Conflitti di deployment per le regole di sicurezza

Per Firebase Realtime Database, Cloud Storage for Firebase e Cloud Firestore, puoi definire le regole di sicurezza nella directory del progetto locale o nella console Firebase.

Un'altra opzione per evitare conflitti di deployment è utilizzare il deployment parziale e definire solo le regole Console Firebase.

Quote di deployment

È possibile (anche se improbabile) che tu possa superare una quota che limita la frequenza o il volume delle operazioni di deployment di Firebase. Ad esempio, quando esegui il deployment di un numero molto elevato di funzioni, potresti ricevere un messaggio di errore HTTP 429 Quota. Per risolvere questi problemi, prova a utilizzare il deployment parziale.

Esegui il rollback di un deployment

Puoi eseguire il rollback di un deployment Firebase Hosting dal Firebase Hosting pagina selezionando l'azione Rollback per la release desiderata.

Al momento non è possibile eseguire il rollback delle release delle regole di sicurezza per Firebase Realtime Database, Cloud Storage for Firebase o Cloud Firestore.

Esegui il deployment di servizi Firebase specifici

Se vuoi eseguire il deployment solo di funzionalità o servizi Firebase specifici, puoi utilizzare una elenco separato da virgole in un flag nel comando firebase deploy. Ad esempio: il comando seguente esegue il deployment di contenuti Firebase Hosting Cloud Storage regole di sicurezza.

firebase deploy --only hosting,storage

La tabella seguente elenca i servizi e le funzionalità disponibili per il deployment parziale. I nomi nei flag corrispondono alle chiavi nel tuo firebase.json.

Esegui il deployment di funzioni specifiche

Quando esegui il deployment delle funzioni, puoi scegliere come target funzioni specifiche. Ad esempio:

firebase deploy --only functions:function1

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

Un'altra opzione consiste nel raggruppare le funzioni in gruppi di esportazione /functions/index.js. Le funzioni di raggruppamento ti consentono di implementare più funzioni con un unico comando.

Ad esempio, puoi scrivere le seguenti funzioni per definire un groupA e un groupB:

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

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

In questo esempio, un file functions/groupB.js separato contiene funzioni aggiuntive che definiscono in modo specifico le funzioni in groupB. Ad esempio:

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

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

In questo esempio, puoi eseguire il deployment di tutte le funzioni groupA eseguendo il seguente comando dalla directory del progetto:

firebase deploy --only functions:groupA

In alternativa, puoi scegliere come target una funzione specifica all'interno di un gruppo eseguendo questo comando :

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

Elimina funzioni

L'interfaccia a riga di comando Firebase supporta i seguenti comandi e opzioni per eliminare le funzioni di cui è stato eseguito il deployment in precedenza:

• Consente di eliminare tutte le funzioni che corrispondono al nome specificato in tutte le regioni:

  firebase functions:delete FUNCTION-1_NAME

• Elimina una funzione specificata in esecuzione in una regione non predefinita:

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

• Elimina più di una funzione:

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

• Elimina un gruppo di funzioni specificato:

  firebase functions:delete GROUP_NAME

• Ignora la richiesta di conferma:

  firebase functions:delete FUNCTION-1_NAME --force

Configura attività basate su script di pre-deployment e post-deployment

Puoi collegare gli script shell al comando firebase deploy per eseguire di pre-deployment e post-deployment. Ad esempio, uno script di pre-deployment eseguire il transpile del codice TypeScript in JavaScript e un hook post-deployment potrebbe inviare una notifica gli amministratori dei nuovi contenuti del sito vengono implementati su Firebase Hosting.

Per configurare gli hook predeploy o postdeploy, aggiungi script bash al file di configurazione firebase.json. Puoi definire script brevi direttamente nel file firebase.json oppure puoi fare riferimento ad altre file nella directory del progetto.

Ad esempio, lo script seguente è l'espressione firebase.json per un'attività post-deployment che invia un messaggio Slack al termine del deployment a Firebase Hosting.

"hosting": {
  // ...

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

Il file di script messageSlack.sh si trova nella directory del progetto e ha il seguente aspetto:

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

Puoi configurare gli hook predeploy e postdeploy per qualsiasi risorsa che puoi implementare. Tieni presente che l'esecuzione di firebase deploy attiva tutte le attività di pre-deployment e post-deployment definite nel file firebase.json. Eseguire solo le attività associate a un account Servizio Firebase, utilizza i comandi di deployment parziale.

Entrambi gli hook predeploy e postdeploy stampano gli stream di output ed errori standard degli script sul terminale. Per i casi di errore, tieni presente quanto segue:

• Se un hook di pre-deployment non viene completato come previsto, il deployment viene annullato.
• Se il deployment non va a buon fine per qualsiasi motivo, gli hook post-deployment non vengono attivati.

Variabili di ambiente

All'interno degli script in esecuzione negli hook di pre-deployment e post-deployment, le variabili di ambiente disponibili:

• $GCLOUD_PROJECT: l'ID del progetto attivo
• $PROJECT_DIR: la directory principale contenente il file firebase.json
• $RESOURCE_DIR: (solo per gli script hosting e functions) il valore percorso della directory che contiene Hosting o Cloud Functions risorse di cui eseguire il deployment

Gestire più istanze Realtime Database

Un progetto Firebase può avere più istanze Firebase Realtime Database. Di per impostazione predefinita, i comandi dell'interfaccia a riga di comando interagiscono con l'istanza del database default.

Tuttavia, puoi interagire con un'istanza di database non predefinita utilizzando il flag --instance DATABASE_NAME. La i seguenti comandi supportano il flag --instance:

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

Riferimento ai comandi

Comandi amministrativi dell'interfaccia a riga di comando

Comandi per la gestione dei progetti

Deployment e sviluppo locale

Questi comandi ti consentono di eseguire il deployment e interagire con il tuo sito Firebase Hosting.

App Distribution comandi

Comandi App Hosting

Comandi Authentication (gestione utenti)

Comandi Cloud Firestore

Comandi Cloud Functions for Firebase

Per ulteriori informazioni, fai riferimento all'ambiente per la configurazione iniziale.

Crashlytics comandi

Comandi Data Connect

Questi comandi e i relativi casi d'uso sono trattati in maggiore dettaglio nella Guida di riferimento per l'interfaccia a riga di comando di Data Connect.

Extensions comandi

Extensions comando publisher

Hosting comandi

Comandi Realtime Database

Tieni presente che puoi creare l'istanza Realtime Database iniziale predefinita nella console Firebase o utilizzando il flusso di lavoro firebase init generale o il flusso firebase init database specifico.

Una volta create, puoi gestirle come descritto in Gestire più istanze Realtime Database.

Comandi Remote Config