Referensi Firebase CLI

Firebase CLI (GitHub) menyediakan beragam alat untuk mengelola, melihat, dan men-deploy ke project Firebase.

Sebelum menggunakan Firebase CLI, siapkan project Firebase.

Menyiapkan atau mengupdate CLI

Instal Firebase CLI

Anda dapat menginstal Firebase CLI menggunakan metode yang cocok dengan sistem operasi, tingkat pengalaman, dan/atau kasus penggunaan Anda. Terlepas dari cara Anda menginstal CLI, Anda memiliki akses ke perintah firebase dan fungsionalitas yang sama.

Windows macOS Linux

Windows

Anda dapat menginstal Firebase CLI untuk Windows menggunakan salah satu opsi berikut:

macOS atau Linux

Anda dapat menginstal Firebase CLI untuk macOS atau Linux menggunakan salah satu opsi berikut:

Login dan menguji Firebase CLI

Setelah menginstal CLI, Anda harus menjalankan autentikasi. Selanjutnya, Anda dapat mengonfirmasi autentikasi dengan mencantumkan project Firebase Anda.

1. Login ke Firebase menggunakan akun Google Anda dengan menjalankan perintah berikut:

   firebase login

   Perintah ini menghubungkan komputer lokal Anda ke Firebase dan memberikan akses ke project Firebase Anda.

2. Uji untuk memastikan bahwa CLI sudah diinstal dan mengakses akun Anda dengan benar dengan menampilkan daftar project Firebase Anda. Jalankan perintah berikut:

   firebase projects:list

   Daftar yang ditampilkan harus sama dengan project Firebase yang tercantum di Firebase console.

Mengupdate ke versi CLI terbaru

Secara umum, Anda sebaiknya menggunakan versi Firebase CLI terbaru.

Cara Anda mengupdate versi CLI bergantung pada sistem operasi dan cara Anda menginstal CLI.

Menggunakan CLI dengan sistem CI

Firebase CLI membutuhkan browser untuk menyelesaikan autentikasi, tetapi CLI sepenuhnya kompatibel dengan CI dan lingkungan headless lainnya.

1. Di komputer yang dilengkapi browser, instal Firebase CLI.

2. Mulai proses login dengan menjalankan perintah berikut:

   firebase login:ci

3. Buka URL yang disediakan, lalu login menggunakan akun Google.

4. Cetak token refresh baru. Sesi CLI saat ini tidak akan terpengaruh.

5. Simpan token output dengan cara yang aman tetapi mudah diakses di sistem CI Anda.

6. Gunakan token ini saat menjalankan perintah firebase. Anda dapat menggunakan salah satu dari dua opsi berikut:

   • Opsi 1: Menyimpan token sebagai variabel lingkungan FIREBASE_TOKEN. Sistem Anda akan otomatis menggunakan token ini.

   • Opsi 2: Menjalankan semua perintah firebase dengan flag --token TOKEN di sistem CI Anda.
     Ini adalah urutan prioritas untuk pemuatan token: flag, variabel lingkungan, project Firebase yang diinginkan.

Menginisialisasi project Firebase

Banyak tugas umum yang dijalankan menggunakan CLI, seperti men-deploy ke project Firebase, memerlukan direktori project. Anda perlu membuat direktori project menggunakan perintah firebase init. Direktori project biasanya merupakan direktori yang sama dengan root kontrol sumber Anda, dan setelah menjalankan firebase init, direktori tersebut akan berisi file konfigurasi firebase.json.

Untuk menginisialisasi project Firebase baru, jalankan perintah berikut dari dalam direktori aplikasi Anda:

firebase init

Perintah firebase init akan memandu Anda menyiapkan direktori project dan beberapa produk Firebase. Selama inisialisasi project, Firebase CLI akan meminta Anda menyelesaikan tugas-tugas berikut:

• Pilih produk Firebase yang diinginkan, yang akan disiapkan di project Firebase Anda.

  Langkah ini akan meminta Anda untuk menetapkan konfigurasi file tertentu bagi produk yang dipilih. Untuk mengetahui informasi lebih lanjut seputar konfigurasi ini, baca dokumentasi produk tertentu yang terkait (misalnya, Hosting). Perlu diperhatikan bahwa Anda dapat menjalankan firebase init nanti untuk menyiapkan produk Firebase lainnya.

• Pilih project Firebase default.

  Langkah ini menghubungkan direktori project saat ini dengan project Firebase, sehingga perintah khusus project (seperti firebase deploy) dijalankan terhadap project Firebase yang sesuai.

  Anda juga dapat menghubungkan beberapa project Firebase (misalnya project staging dan produksi) dengan direktori project yang sama.

Di akhir inisialisasi, Firebase akan otomatis membuat dua file berikut di root direktori aplikasi lokal Anda:

• File konfigurasi firebase.json yang mencantumkan konfigurasi project Anda.

• File .firebaserc yang menyimpan alias project Anda.

File firebase.json

Perintah firebase init akan membuat file konfigurasi firebase.json di root direktori project Anda.

File firebase.json diperlukan untuk men-deploy aset dengan Firebase CLI karena file tersebut menentukan file dan setelan mana dari direktori project Anda yang di-deploy ke project Firebase Anda. Karena beberapa setelan dapat ditentukan di direktori project Anda atau Firebase console, pastikan Anda menyelesaikan setiap potensi konflik deployment.

Anda dapat mengonfigurasi sebagian besar opsi Firebase Hosting secara langsung di file firebase.json. Namun, untuk layanan Firebase lain yang dapat di-deploy dengan Firebase CLI, perintah firebase init akan menghasilkan file tertentu yang dapat Anda gunakan untuk menentukan setelan bagi layanan tersebut, misalnya file index.js untuk Cloud Functions. Anda juga dapat menyiapkan hook pra-deployment atau pasca-deployment di file firebase.json.

Berikut adalah contoh file firebase.json dengan setelan default jika Anda memilih Firebase Hosting, Cloud Firestore, dan Cloud Functions for Firebase (dengan opsi lint dan sumber TypeScript dipilih) selama inisialisasi.

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

Meskipun firebase.json digunakan secara default, Anda dapat meneruskan flag --config PATH untuk menentukan file konfigurasi alternatif.

Konfigurasi untuk beberapa database Cloud Firestore

Saat Anda menjalankan firebase init, file firebase.json akan berisi satu kunci firestore yang sesuai dengan database default project Anda, seperti yang ditunjukkan di atas.

Jika project Anda berisi beberapa database Cloud Firestore, edit file firebase.json untuk mengaitkan berbagai Cloud Firestore Security Rules dan file sumber indeks database dengan setiap database. Ubah file dengan array JSON, dengan satu entri untuk setiap database.

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

File Cloud Functions yang akan diabaikan saat di-deploy

Pada waktu deployment fungsi, CLI akan otomatis menentukan daftar file dalam direktori functions yang akan diabaikan. Hal ini mencegah deployment ke file yang tidak relevan di backend yang dapat meningkatkan ukuran data deployment.

Daftar file yang diabaikan secara default, yang ditampilkan dalam format JSON, adalah:

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

Jika Anda menambahkan nilai kustom sendiri untuk ignore di firebase.json, pastikan Anda mempertahankan (atau menambahkan, jika hilang) daftar file yang ditampilkan di atas.

Mengelola alias project

Anda dapat menghubungkan beberapa project Firebase dengan direktori project yang sama. Misalnya, Anda mungkin ingin menggunakan satu project Firebase untuk staging dan satu lagi untuk produksi. Dengan menggunakan lingkungan project yang berbeda, Anda dapat memverifikasi perubahan sebelum di-deploy ke produksi. Dengan perintah firebase use, Anda dapat beralih antar-alias dan membuat alias baru.

Menambahkan alias project

Project Firebase yang Anda pilih selama inisialisasi project akan otomatis mendapatkan alias default. Namun, agar perintah khusus project dijalankan terhadap project Firebase lain sekaligus tetap menggunakan direktori project yang sama, jalankan perintah berikut dari dalam direktori project Anda:

firebase use --add

Perintah ini akan meminta Anda untuk memilih project Firebase lain dan menetapkannya sebagai alias. Penetapan alias ditulis ke file .firebaserc di dalam direktori project Anda.

Menggunakan alias project

Untuk menggunakan alias project Firebase yang ditetapkan, jalankan salah satu perintah berikut dari dalam direktori project Anda.

Anda dapat mengganti project yang digunakan sebagai project aktif saat ini dengan meneruskan flag --project dengan perintah CLI apa pun. Misalnya: Anda dapat menyetel CLI agar dijalankan terhadap project Firebase yang telah Anda beri alias staging. Jika ingin menjalankan perintah tunggal terhadap project Firebase yang telah Anda beri alias prod, Anda dapat menjalankan, misalnya, firebase deploy --project=prod.

Kontrol sumber dan alias project

Secara umum, Anda harus melakukan check in file .firebaserc ke dalam kontrol sumber agar tim Anda dapat berbagi alias project. Namun, untuk project open source atau template starter, biasanya Anda tidak perlu melakukan check in file .firebaserc.

Jika Anda memiliki project pengembangan khusus untuk penggunaan sendiri, Anda dapat meneruskan flag --project dengan setiap perintah atau menjalankan firebase use PROJECT_ID tanpa menetapkan alias untuk project Firebase.

Menyalurkan dan menguji project Firebase Anda secara lokal

Anda dapat melihat dan menguji project Firebase pada URL yang dihosting secara lokal sebelum di-deploy ke produksi. Jika Anda hanya ingin menguji fitur tertentu, gunakan daftar yang dipisahkan koma dalam sebuah flag pada perintah firebase serve.

Jalankan perintah berikut dari root direktori project lokal jika Anda ingin melakukan salah satu dari tugas berikut:

• Melihat konten statis untuk aplikasi yang dihosting Firebase.
• Gunakan Cloud Functions untuk membuat konten dinamis Firebase Hosting dan sebaiknya gunakan fungsi HTTP produksi (yang di-deploy) untuk mengemulasikan Hosting di URL lokal.

firebase serve --only hosting

Mengemulasikan project Anda menggunakan fungsi HTTP lokal

Jalankan salah satu perintah berikut dari direktori project Anda untuk mengemulasikan project menggunakan fungsi HTTP lokal.

• Untuk mengemulasikan fungsi HTTP dan hosting untuk pengujian pada URL lokal, gunakan salah satu perintah berikut:

  firebase serve

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

• Untuk mengemulasikan fungsi HTTP saja, gunakan perintah berikut:

  firebase serve --only functions

Menguji dari perangkat lokal lainnya

Secara default, firebase serve hanya merespons permintaan dari localhost. Artinya, Anda akan dapat mengakses konten yang dihosting dari browser web komputer Anda, tetapi tidak dari perangkat lain di jaringan Anda. Jika Anda ingin melakukan pengujian dari perangkat lokal lainnya, gunakan flag --host, seperti ini:

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

Men-deploy ke project Firebase

Firebase CLI mengelola deployment kode dan aset ke project Firebase Anda, termasuk:

• Rilis baru dari situs Firebase Hosting Anda
• Cloud Functions for Firebase baru, yang diperbarui, atau yang sudah ada
• Skema dan konektor baru atau yang diperbarui untuk Firebase Data Connect
• Aturan untuk Firebase Realtime Database
• Aturan untuk Cloud Storage for Firebase
• Aturan untuk Cloud Firestore
• Indeks untuk Cloud Firestore

Untuk men-deploy ke project Firebase, jalankan perintah berikut dari direktori project Anda:

firebase deploy

Jika ingin, Anda dapat menambahkan komentar ke setiap deployment. Komentar ini akan ditampilkan dengan informasi penerapan lainnya di halaman Firebase Hosting project Anda. Contoh:

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

Saat menggunakan perintah firebase deploy, Anda harus memperhatikan hal-hal berikut:

• Untuk men-deploy resource dari direktori project, direktori project tersebut harus memiliki file firebase.json. File ini dibuat otomatis untuk Anda dengan perintah firebase init.

• Secara default, firebase deploy akan membuat rilis untuk semua resource yang dapat di-deploy dalam direktori project Anda. Untuk men-deploy layanan atau fitur Firebase tertentu, gunakan deployment parsial.

Konflik deployment untuk aturan keamanan

Untuk Firebase Realtime Database, Cloud Storage for Firebase, dan Cloud Firestore, Anda dapat menentukan aturan keamanan di direktori project lokal atau di Firebase console.

Opsi lain untuk menghindari konflik deployment adalah menggunakan deployment parsial dan hanya menentukan aturan di Firebase console.

Kuota deployment

Anda mungkin saja (meskipun kemungkinannya kecil) melebihi kuota yang membatasi tingkat atau volume operasi deployment Firebase. Misalnya, saat men-deploy fungsi dalam jumlah besar, Anda mungkin menerima pesan error HTTP 429 Quota. Untuk mengatasi masalah tersebut, coba gunakan deployment parsial.

Me-roll back deployment

Anda dapat me-roll back deployment Firebase Hosting dari halaman Firebase Hosting project Anda dengan memilih tindakan Rollback untuk rilis yang diinginkan.

Saat ini, roll back rilis aturan keamanan untuk Firebase Realtime Database, Cloud Storage for Firebase, atau Cloud Firestore belum bisa dilakukan.

Men-deploy layanan Firebase tertentu

Jika Anda hanya ingin men-deploy fitur atau layanan Firebase tertentu, gunakan daftar yang dipisahkan koma dalam sebuah flag pada perintah firebase deploy. Misalnya, perintah berikut men-deploy konten Firebase Hosting dan aturan keamanan Cloud Storage.

firebase deploy --only hosting,storage

Tabel berikut berisi daftar layanan dan fitur yang tersedia untuk deployment parsial. Nama-nama dalam flag sesuai dengan kunci dalam file konfigurasi firebase.json Anda.

Men-deploy fungsi tertentu

Saat men-deploy fungsi, Anda dapat menarget fungsi tertentu. Contoh:

firebase deploy --only functions:function1

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

Opsi lainnya adalah mengelompokkan fungsi ke dalam grup ekspor di file /functions/index.js Anda. Dengan mengelompokkan fungsi, Anda dapat men-deploy beberapa fungsi menggunakan satu perintah.

Misalnya, Anda dapat menulis fungsi berikut untuk menentukan groupA dan groupB:

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

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

Dalam contoh ini, file functions/groupB.js terpisah berisi fungsi tambahan yang secara khusus menentukan fungsi di groupB. Contoh:

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

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

Dalam contoh ini, Anda dapat men-deploy semua fungsi groupA dengan menjalankan perintah berikut dari direktori project:

firebase deploy --only functions:groupA

Atau, Anda dapat menargetkan fungsi tertentu dalam grup dengan menjalankan perintah berikut:

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

Menghapus fungsi

Firebase CLI mendukung perintah dan opsi berikut untuk menghapus fungsi yang sebelumnya di-deploy:

• Menghapus semua fungsi yang cocok dengan nama yang ditentukan di semua region:

  firebase functions:delete FUNCTION-1_NAME

• Menghapus fungsi yang ditentukan, yang berjalan di region non-default:

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

• Menghapus lebih dari satu fungsi:

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

• Menghapus grup fungsi tertentu:

  firebase functions:delete GROUP_NAME

• Mengabaikan permintaan konfirmasi:

  firebase functions:delete FUNCTION-1_NAME --force

Menyiapkan tugas dengan skrip untuk pra-deployment dan pasca-deployment

Anda dapat menghubungkan skrip shell ke perintah firebase deploy untuk melakukan tugas pra-deployment atau pasca-deployment. Misalnya, skrip pra-deployment dapat melakukan transpilasi kode TypeScript ke JavaScript, dan hook pasca-deployment dapat memberi tahu administrator tentang deployment konten situs baru ke Firebase Hosting.

Untuk menyiapkan hook pra-deployment atau pasca-deployment, tambahkan skrip bash ke file konfigurasi firebase.json. Anda dapat menentukan skrip singkat secara langsung di file firebase.json, atau merujuk ke file lain yang ada di direktori project Anda.

Misalnya, skrip berikut adalah ekspresi firebase.json untuk tugas pasca-deployment yang mengirim pesan Slack setelah deployment ke Firebase Hosting berhasil.

"hosting": {
  // ...

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

File skrip messageSlack.sh berada dalam direktori project dan akan terlihat seperti ini:

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

Anda dapat menyiapkan hook predeploy dan postdeploy untuk aset mana pun yang dapat di-deploy. Perlu diperhatikan bahwa menjalankan firebase deploy akan memicu semua tugas pra-deployment dan pasca-deployment yang ditentukan dalam file firebase.json Anda. Untuk menjalankan tugas yang terkait dengan layanan Firebase tertentu saja, gunakan perintah deployment parsial.

Baik hook predeploy maupun postdeploy akan mencetak output standar dan aliran error skrip ke terminal. Untuk kasus kegagalan, perhatikan hal-hal berikut:

• Jika hook pra-deployment gagal diselesaikan seperti yang diharapkan, deployment akan dibatalkan.
• Jika deployment gagal karena suatu alasan, hook pasca-deployment tidak akan dipicu.

Variabel lingkungan

Dalam skrip yang berjalan di hook pra-deployment dan pasca-deployment, tersedia variabel lingkungan berikut:

• $GCLOUD_PROJECT: Project ID dari project yang aktif
• $PROJECT_DIR: Direktori root yang berisi file firebase.json
• $RESOURCE_DIR: (Hanya untuk skrip hosting dan functions) Lokasi direktori yang berisi resource Hosting atau Cloud Functions yang akan di-deploy

Mengelola beberapa instance Realtime Database

Satu project Firebase dapat memiliki beberapa instance Firebase Realtime Database. Secara default, perintah CLI berinteraksi dengan instance database default Anda.

Namun, Anda dapat berinteraksi dengan instance database non-default menggunakan flag --instance DATABASE_NAME. Perintah berikut mendukung flag --instance:

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

Referensi perintah

Perintah administratif CLI

Perintah pengelolaan project

Deployment dan pengembangan lokal

Dengan perintah ini, Anda dapat men-deploy dan berinteraksi dengan situs Firebase Hosting.

Perintah App Distribution

Perintah App Hosting

Perintah (pengelolaan pengguna) Authentication

Perintah Cloud Firestore

Perintah Cloud Functions for Firebase

Untuk mengetahui informasi lebih lanjut, baca dokumentasi konfigurasi lingkungan.

Perintah Crashlytics

Perintah Data Connect

Perintah ini dan kasus penggunaannya dibahas lebih mendetail dalam panduan referensi Data Connect CLI.

Perintah Extensions

Perintah penayang Extensions

Perintah Hosting

Perintah Realtime Database

Perlu diperhatikan bahwa Anda dapat membuat instance Realtime Database default awal di Firebase console atau menggunakan alur kerja firebase init umum atau alur firebase init database tertentu.

Setelah instance dibuat, Anda dapat mengelolanya seperti yang dibahas di bagian Mengelola beberapa instance Realtime Database.

Perintah Remote Config