Firebase CLI 參考資料

Firebase CLI (GitHub) 提供各種工具，可用於管理、查看及部署至 Firebase 專案。

使用 Firebase CLI 前，請設定 Firebase 專案。

設定或更新 CLI

安裝 Firebase CLI

您可以使用符合作業系統、經驗程度和/或用途的方法安裝 Firebase CLI。無論您如何安裝 CLI，都能使用相同的功能和 firebase 指令。

Windows macOS Linux

Windows

您可以使用下列其中一種方法安裝 Windows 適用的 Firebase CLI 選項：

macOS 或 Linux

您可以使用下列其中一個選項，安裝 macOS 或 Linux 版 Firebase CLI：

登入並測試 Firebase CLI

安裝 CLI 後，您必須進行驗證。接著您可以確認 藉此驗證自己的 Firebase 專案

1. 請按照下列步驟操作，使用您的 Google 帳戶登入 Firebase 指令：

   firebase login

   此指令可將您的本機連線至 Firebase，並授予您 Firebase 專案的存取權。

2. 請列出 Firebase 專案，測試 CLI 是否已正確安裝並存取您的帳戶。執行下列指令：

   firebase projects:list

   畫面上顯示的清單應與列出的 Firebase 專案相同 Firebase 控制台。

更新至最新的 CLI 版本

一般來說，建議您使用最新的 Firebase CLI 版本。

更新 CLI 版本的方式取決於您的作業系統及 安裝 CLI

搭配使用 CLI 與持續整合系統

Firebase CLI 需要瀏覽器才能完成驗證，但 CLI 與 CI 和其他無頭環境完全相容。

1. 在裝有瀏覽器的電腦上，安裝 Firebase CLI。

2. 執行下列指令，啟動登入程序：

   firebase login:ci

3. 前往提供的網址，然後使用 Google 帳戶登入。

4. 列印新文件 更新權杖。 目前的 CLI 工作階段不會受到影響。

5. 在 CI 系統中以安全且可存取的方式儲存輸出憑證。

6. 執行 firebase 指令時，請使用這個符記。您可以使用 下列兩個選項：

   • 方法 1：將權杖儲存為環境變數 FIREBASE_TOKEN。系統會自動使用權杖。

   • 選項 2：使用以下指令執行所有 firebase 指令： --token TOKEN 旗標。
     這是權杖載入的優先順序：旗標、環境 變數和所需的 Firebase 專案

初始化 Firebase 專案

使用 CLI 執行的許多常見工作 (例如部署至 Firebase 專案) 都需要專案目錄。建立專案目錄 呼叫 firebase init 指令專案目錄通常與來源控管根目錄相同，執行 firebase init 後，目錄會包含 firebase.json 設定檔。

如要初始化新的 Firebase 專案，請在應用程式目錄中執行下列指令：

firebase init

使用 firebase init 指令逐步設定專案目錄 和部分 Firebase 產品在專案初始化期間，Cloud CLI 的 Firebase CLI 要求您完成下列工作：

• 選取要在 Firebase 專案中設定的 Firebase 產品。

  這個步驟會提示您針對 所選產品。如要進一步瞭解這些設定，請參閱特定產品的說明文件 (例如 Hosting)。請注意，您隨時可以執行 firebase init 來設定更多 Firebase 產品。

• 選取預設的 Firebase 專案。

  這個步驟會將目前的專案目錄與 Firebase 專案建立關聯， 該專案的專屬指令 (例如 firebase deploy) 會對 適當的 Firebase 專案

  您也可以將 連結多個 Firebase 專案 (例如測試專案和正式環境專案) 使用同一專案 目錄。

在初始化結束時，Firebase 會自動在本機應用程式目錄的根目錄中建立下列兩個檔案：

• 列出一份清單的 firebase.json 設定檔 您的專案設定。

• 用於儲存專案別名的 .firebaserc 檔案。

firebase.json 檔案

firebase init 指令會在專案目錄的根目錄中建立 firebase.json 設定檔。

必須要有 firebase.json 檔案，才能 使用 Firebase CLI 部署資產，因為它指定了 系統會將專案目錄中的檔案和設定部署至 Firebase 專案。由於部分設定可在專案目錄或 Firebase 控制台中定義，請務必解決任何潛在的部署衝突。

您可以直接在 firebase.json 檔案中設定大部分的 Firebase Hosting 選項。不過，對於其他可透過 Firebase CLI 部署的 Firebase 服務，firebase init 指令會建立特定檔案，讓您為這些服務定義設定，例如 Cloud Functions 的 index.js 檔案。你可以 也會在 firebase.json 檔案中設定 predeploy 或 postdeploy 掛鉤。

以下是採用預設設定的 firebase.json 檔案範例， 選取 Firebase Hosting、Cloud Firestore 和 Cloud Functions for Firebase (選取 TypeScript 來源和 Lint 選項)。

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

根據預設，使用 firebase.json 時，您可以傳遞 使用 --config PATH 標記指定替代值 設定檔

多個 Cloud Firestore 資料庫的設定

執行 firebase init 時，firebase.json 檔案會包含 與專案預設資料庫相對應的 firestore 金鑰，如圖所示 。

如果專案包含多個 Cloud Firestore 資料庫，請編輯 firebase.json 檔案，將不同的 Cloud Firestore Security Rules 和資料庫索引來源檔案與每個資料庫建立關聯。使用 JSON 陣列，每個資料庫都有一個項目。

      "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 個檔案

在函式部署期間，CLI 會自動指定 functions 目錄中要忽略的檔案清單。這個 可避免部署至後端的非必要檔案 可增加部署的資料大小

以下是預設為 JSON 格式忽略的檔案清單：

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

如果您在 firebase.json 中為 ignore 新增自訂值，請務必保留上述檔案清單 (如果缺少，請新增)。

管理專案別名

您可以將多個 Firebase 專案與相同的專案目錄建立關聯。舉例來說，您可能會想將一個 Firebase 專案用於測試環境，再使用另一個 Firebase 專案。 。使用不同的專案環境，您可以在部署至正式環境前驗證變更。firebase use 指令可讓您切換別名，以及建立新的別名。

新增專案別名

在專案期間選取 Firebase 專案時 初始化時，專案就會自動 已指派 default 的別名。然而，如要允許特定專案的指令 針對不同的 Firebase 專案執行，但仍會使用同一個專案 ，從專案目錄中執行下列指令：

firebase use --add

這個指令會提示您選取其他 Firebase 專案，並指派 並設為別名別名指派設定會寫入當中的 .firebaserc 檔案 。

使用專案別名

如要使用指派的 Firebase 專案別名，請執行下列指令： 。

您可以透過傳遞 --project 標記和任何 CLI 指令，覆寫目前用於使用中的專案。舉例來說，您可以設定 針對您指派 staging 的 Firebase 專案執行 CLI 別名。如果您想對某個 Firebase 專案 執行單一指令 您指派了 prod 別名，之後就能執行 舉例來說， firebase deploy --project=prod。

原始碼控制和專案別名

一般來說，您應該將 .firebaserc 檔案納入來源控制，讓團隊成員分享專案別名。不過，對於開放原始碼專案或入門範本，您通常不應檢查 .firebaserc 檔案。

如果您有僅供使用的開發專案，可以 --project 旗標，每個指令或執行 firebase use PROJECT_ID 而未指派別名給 Firebase 專案

在本機提供並測試 Firebase 專案

您可以先透過本機託管的網址查看及測試 Firebase 專案， 部署至實際工作環境如果只想測試特定功能 在 firebase serve 指令的旗標中以半形逗號分隔的清單。

如果您符合以下條件，請從本機專案的根目錄執行下列指令： 想要執行下列任一工作：

• 查看 Firebase 代管應用程式的靜態內容。
• 使用 Cloud Functions 即可為下列項目產生動態內容： Firebase Hosting，而您想要使用 使用 Production (已部署) HTTP 函式，在本機網址中模擬 Hosting。

firebase serve --only hosting

使用本機 HTTP 函式模擬專案

在專案目錄中執行下列任一指令，即可使用本機 HTTP 函式模擬專案。

• 如要模擬 HTTP 函式並在本機網址上測試代管服務，請使用下列任一指令：

  firebase serve

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

• 如要模擬 HTTP 函式，請使用下列指令：

  firebase serve --only functions

透過其他本機裝置進行測試

根據預設，firebase serve 只會回應 localhost 提出的要求。也就是說，您可以透過電腦的網路瀏覽器存取託管內容，但無法透過網路上的其他裝置存取。如要從其他本機裝置進行測試，請使用 --host 標記，如下所示：

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

部署至 Firebase 專案

Firebase CLI 可管理程式碼和素材資源的 Firebase 專案部署作業，包括：

• 你的 Firebase Hosting 個網站最新版本
• 新增、更新或現有的Cloud Functions for Firebase
• 「Firebase Data Connect」的全新或已更新結構定義和連接器
• 「Firebase Realtime Database」的規則
• 「Cloud Storage for Firebase」的規則
• 「Cloud Firestore」的規則
• Cloud Firestore 的索引

如要部署至 Firebase 專案，請在專案中執行下列指令 目錄：

firebase deploy

您可以選擇為每個部署作業加入註解。這則留言會與其他部署資訊一併顯示在專案的 Firebase Hosting 頁面上。例如：

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

使用 firebase deploy 指令時，請注意下列事項：

• 如要從專案目錄部署資源，請前往專案目錄 「必須」含有 firebase.json 檔案。firebase init 指令會自動為您建立這個檔案。

• 根據預設，firebase deploy 會為專案目錄中的所有可部署資源建立版本。如要部署特定 Firebase 服務或功能，請使用部分部署功能。

安全性規則的部署作業衝突

對於 Firebase Realtime Database、Cloud Storage for Firebase 和 Cloud Firestore， 您可以在本機專案目錄或 Firebase 控制台。

另一種避免部署衝突的方法是使用部分部署，並只在 Firebase 控制台中定義規則。

部署配額

您可能會 (但不太可能) 超過配額上限 或是為 Firebase 部署作業的執行速率或資料量舉例來說 您可能會收到 HTTP 429 Quota 錯誤訊息。如要解決這類問題，請嘗試使用部分部署。

復原部署作業

您可以選取所需版本的「Rollback」動作，從專案的 Firebase Hosting 頁面復原 Firebase Hosting 部署作業。

目前無法針對 Firebase Realtime Database、Cloud Storage for Firebase 或 Cloud Firestore 回溯發布安全性規則。

部署特定 Firebase 服務

如果您只想部署特定 Firebase 服務或功能，可以使用 firebase deploy 指令的旗標中以半形逗號分隔的清單。例如： 下列指令會部署 Firebase Hosting 內容並 Cloud Storage 項安全性規則。

firebase deploy --only hosting,storage

下表列出可供部分使用的服務和功能 可能面臨擴充性、監控、持續整合 和部署等方面的挑戰旗標中的名稱會與 firebase.json 設定檔。

部署特定函式

部署函式時，您可以指定特定函式。例如：

firebase deploy --only functions:function1

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

另一種方法是將函式分組為 /functions/index.js 檔案。分組函式可讓您部署 使用單一指令

例如，您可以編寫下列函式來定義 groupA 和 groupB：

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

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

在這個範例中，單獨的 functions/groupB.js 檔案包含其他函式，可明確定義 groupB 中的函式。例如：

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

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

在這個範例中，您可以從專案目錄執行下列指令，部署所有 groupA 函式：

firebase deploy --only functions:groupA

或者，您也可以執行下列指令，指定群組中的特定函式：

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

刪除函式

Firebase CLI 支援下列指令和選項，可用來刪除先前部署的函式：

• 刪除所有區域中符合指定名稱的所有函式：

  firebase functions:delete FUNCTION-1_NAME

• 刪除在非預設區域中執行的指定函式：

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

• 刪除多個函式：

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

• 刪除指定的函式群組：

  firebase functions:delete GROUP_NAME

• 略過確認提示：

  firebase functions:delete FUNCTION-1_NAME --force

設定預先部署和部署指令碼後的工作

您可以將 Shell 指令碼連結至 firebase deploy 指令，執行預部署或後部署工作。舉例來說，預先部署指令碼可將 TypeScript 程式碼轉譯為 JavaScript，而部署後掛鉤則可通知管理員新網站內容已部署至 Firebase Hosting。

如要設定預先部署或後部署掛鉤，請將 bash 指令碼新增至 firebase.json 設定檔。您可以定義 直接加入 firebase.json 檔案中的簡短指令碼，或者，您也可以 存放在專案目錄中的檔案

舉例來說，以下指令碼是 firebase.json 運算式的 部署後，在成功部署後，會將 Slack 訊息傳送至 Firebase Hosting。

"hosting": {
  // ...

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

messageSlack.sh 指令碼檔案位於專案目錄中，如下所示：

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

您可以為下列任一資源設定 predeploy 和 postdeploy 掛鉤 您可以部署的資產請注意，執行 firebase deploy 會觸發 firebase.json 檔案中定義的所有預先部署和後期部署工作。如要只執行與特定 Firebase 服務相關聯的工作，請使用部分部署指令。

predeploy 和 postdeploy 鉤子會將指令碼的標準輸出內容和錯誤串流輸出至終端機。針對失敗案例，請注意下列事項：

• 如果預先部署掛鉤無法如預期完成，系統會取消部署作業。
• 如果部署作業因任何原因失敗，系統就不會觸發部署後掛鉤。

環境變數

在預先部署和後部署掛鉤執行的指令碼中，將下列程式碼 可用的環境變數：

• $GCLOUD_PROJECT：有效專案的 ID
• $PROJECT_DIR：包含 firebase.json 檔案的根目錄
• $RESOURCE_DIR：(僅適用於 hosting 和 functions 指令碼) 包含要部署的 Hosting 或 Cloud Functions 資源的目錄位置

管理多個「Realtime Database」執行個體

一個 Firebase 專案可以有多個 Firebase Realtime Database 例項。根據預設，CLI 指令會與預設資料庫例項互動。

不過，您可以使用 --instance DATABASE_NAME 標記。下列指令支援 --instance 旗標：

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

指令參考資料

CLI 管理指令

專案管理指令

部署和本機開發

這些指令可讓您部署 Firebase Hosting 網站並與之互動。

App Distribution 指令

App Hosting 指令

Authentication (使用者管理) 指令

Cloud Firestore 指令

Cloud Functions for Firebase 指令

詳情請參閱環境設定說明文件。

Crashlytics 指令

Data Connect 指令

如要進一步瞭解這些指令及其用途，請參閱 Data Connect CLI 參考指南。

Extensions 指令

Extensions 個發布商指令

Hosting 指令

Realtime Database 指令

請注意，您可以在Realtime Database Firebase主控台或使用一般firebase init firebase init database 流程。

建立執行個體後，您可以按照下列說明管理執行個體 管理多個 Realtime Database 執行個體。

Remote Config 指令