Firebase CLI 參考

Firebase CLI ( GitHub ) 提供了各種用於管理、檢視和部署到 Firebase 專案的工具。

在使用 Firebase CLI 之前,請先設定一個 Firebase 專案

設定或更新 CLI

安裝 Firebase CLI

您可以使用與您的作業系統、經驗等級和/或用例相符的方法來安裝 Firebase CLI。無論您如何安裝 CLI,您都可以存取相同的功能和firebase命令。

Windows macOS Linux

視窗

您可以使用下列選項之一安裝適用於 Windows 的 Firebase CLI:

選項描述推薦用於...
獨立的二進位文件下載 CLI 的獨立二進位。然後,您可以存取可執行檔以開啟可以運行firebase命令的 shell。新開發商

不使用或不熟悉Node.js 的開發人員
新專案管理使用 npm(節點套件管理器)安裝 CLI 並啟用全域可用的firebase指令。使用Node.js 的開發人員

獨立的二進位文件

若要下載並執行 Firebase CLI 的二進位文件,請按照以下步驟操作:

  1. 下載適用於 Windows 的 Firebase CLI 二進位

  2. 存取二進位檔案以開啟一個 shell,您可以在其中執行firebase命令。

  3. 繼續登入並測試 CLI

新專案管理

若要使用npm (節點套件管理器)安裝 Firebase CLI,請執行下列步驟:

  1. 使用nvm-windows (節點版本管理器)安裝Node.js。安裝 Node.js 會自動安裝npm指令工具。

  2. 執行以下命令,透過npm安裝 Firebase CLI:

    npm install -g firebase-tools

    此指令啟用全域可用的firebase指令。

  3. 繼續登入並測試 CLI

macOS 或 Linux

您可以使用下列選項之一安裝適用於 macOS 或 Linux 的 Firebase CLI:

選項描述推薦用於...
自動安裝腳本執行一個指令,自動偵測您的作業系統,下載最新的 CLI 版本,然後啟用全域可用的firebase指令。新開發商

不使用或不熟悉Node.js 的開發人員

CI/CD環境中自動部署
獨立的二進位文件下載 CLI 的獨立二進位。然後,您可以配置並執行二進位檔案以適合您的工作流程。使用 CLI 完全可自訂的工作流程
新專案管理使用 npm(節點套件管理器)安裝 CLI 並啟用全域可用的firebase指令。使用Node.js 的開發人員

自動安裝腳本

若要使用自動安裝腳本安裝 Firebase CLI,請依照下列步驟操作:

  1. 執行以下 cURL 命令:

    curl -sL https://firebase.tools | bash

    此腳本會自動偵測您的作業系統,下載最新的 Firebase CLI 版本,然後啟用全域可用的firebase指令。

  2. 繼續登入並測試 CLI

有關自動安裝腳本的更多範例和詳細信息,請參閱firebase.tools上的腳本原始碼。

獨立的二進位文件

若要下載並執行特定於您的作業系統的 Firebase CLI 的二進位文件,請按照以下步驟操作:

  1. 下載適用於您的作業系統的 Firebase CLI 二進位檔案: macOS | Linux

  2. (可選)設定全域可用的firebase指令。

    1. 透過運行chmod +x ./firebase_tools使二進位可執行檔。
    2. 將二進位檔案的路徑新增到您的 PATH 中。
  3. 繼續登入並測試 CLI

新專案管理

若要使用npm (節點套件管理器)安裝 Firebase CLI,請執行下列步驟:

  1. 使用nvm (節點版本管理員)安裝Node.js。
    安裝 Node.js 會自動安裝npm指令工具。

  2. 執行以下命令,透過npm安裝 Firebase CLI:

    npm install -g firebase-tools

    此指令啟用全域可用的firebase指令。

  3. 繼續登入並測試 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 的安裝方式。

視窗

  • 獨立二進位檔案下載新版本,然後在您的系統上取代它
  • npm :運行npm install -g firebase-tools

蘋果系統

  • 自動安裝腳本:執行curl -sL https://firebase.tools | upgrade=true bash
  • 獨立二進位檔案下載新版本,然後在您的系統上取代它
  • npm :運行npm install -g firebase-tools

Linux

  • 自動安裝腳本:執行curl -sL https://firebase.tools | upgrade=true bash
  • 獨立二進位檔案下載新版本,然後在您的系統上取代它
  • npm :運行npm install -g firebase-tools

將 CLI 與 CI 系統結合使用

Firebase CLI 需要瀏覽器來完成身份驗證,但 CLI 與 CI 和其他無頭環境完全相容。

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

  2. 透過執行以下命令啟動登入程序:

    firebase login:ci
  3. 造訪提供的 URL,然後使用 Google 帳戶登入。

  4. 列印新的刷新令牌。當前 CLI 會話​​不會受到影響。

  5. 以安全但可存取的方式將輸出令牌儲存在 CI 系統中。

  6. 運行firebase指令時使用此令牌。您可以使用以下兩個選項之一:

    • 選項 1:將令牌儲存為環境變數FIREBASE_TOKEN 。您的系統將自動使用該令牌。

    • 選項 2: CI 系統中使用--token TOKEN標誌執行所有firebase指令。
      這是令牌載入的優先順序:標誌、環境變數、所需的 Firebase 項目。

初始化 Firebase 項目

使用 CLI 執行的許多常見任務(例如部署到 Firebase 專案)需要專案目錄。您可以使用firebase init指令建立專案目錄。專案目錄通常與原始碼管理根目錄相同,運行firebase init後,該目錄包含一個firebase.json設定檔。

若要初始化新的 Firebase 項目,請從應用程式的目錄中執行以下命令:

firebase init

firebase init指令將引導您完成專案目錄和一些 Firebase 產品的設定。在專案初始化期間,Firebase CLI 要求您完成以下任務:

  • 選擇要在您的 Firebase 專案中設定的所需 Firebase 產品。

    此步驟提示您為所選產品的特定檔案設定配置。有關這些配置的更多詳細信息,請參閱特定產品的文檔(例如Hosting )。請注意,您隨時可以稍後運行firebase init來設定更多 Firebase 產品。

  • 選擇預設的 Firebase 項目。

    此步驟將目前專案目錄與 Firebase 專案關聯,以便針對適當的 Firebase 專案執行特定於專案的命令(例如firebase deploy )。

    也可以將多個 Firebase 專案(例如暫存專案和生產專案)與相同專案目錄關聯

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

firebase.json文件

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

使用 Firebase CLI 部署資產需要firebase.json文件,因為它指定將專案目錄中的哪些文件和設定部署到 Firebase 專案。由於某些設定可以在專案目錄或 Firebase 控制台中定義,因此請確保解決任何潛在的部署衝突

您可以直接在firebase.json檔案中配置大多數 Firebase 託管選項。但是,對於可以使用 Firebase CLI 部署的其他 Firebase 服務firebase init命令會建立特定文件,您可以在其中定義這些服務的設置,例如 Cloud Functions 的index.js文件。您也可以在firebase.json檔案中設定predeploy 或 postdeploy 掛鉤

如果您在初始化期間選擇 Firebase Hosting、Cloud Firestore 和 Cloud Functions for Firebase(選擇了 TypeScript 來源和 lint 選項),則以下是具有預設設定的範例firebase.json檔案。

{
  "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 安全性規則和資料庫索引來源檔案與每個資料庫關聯。使用 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 專案別名,請從專案目錄中執行下列任一命令。

命令描述
firebase use查看專案目錄目前定義的別名列表
firebase use \
PROJECT_ID|ALIAS
指示所有指令針對指定的 Firebase 專案運行。
CLI 使用該項目作為目前「活動項目」。
firebase use --clear清除活動項目。

在執行其他 CLI 指令之前,執行firebase use PROJECT_ID|ALIAS設定新的活動項目。

firebase use \
--unalias PROJECT_ALIAS
從專案目錄中刪除別名。

您可以透過使用任何 CLI 指令傳遞--project標誌來覆寫目前活動項目所使用的項目。例如:您可以將 CLI 設定為針對已指派staging別名的 Firebase 專案執行。如果您想要對已指派prod別名的 Firebase 專案執行單一指令,則可以執行firebase deploy --project=prod

原始碼控制和專案別名

一般來說,您應該將.firebaserc檔案簽入原始碼管理,以允許您的團隊共用專案別名。但是,對於開源專案或入門模板,您通常不應簽入.firebaserc檔案。

如果您有一個僅供您使用的開發項目,您可以在每個命令中傳遞--project標誌,或執行firebase use PROJECT_ID而不為 Firebase 專案指派別名。

在本地提供並測試您的 Firebase 項目

在部署到生產環境之前,您可以在本機託管的 URL 上檢視和測試您的 Firebase 專案。如果您只想測試選定的功能,則可以在firebase serve指令的標誌中使用逗號分隔的清單。

如果您要執行下列任一任務,請從本機專案目錄的根目錄執行下列命令:

  • 查看 Firebase 託管應用程式的靜態內容。
  • 使用 Cloud Functions為 Firebase Hosting 產生動態內容,並且您希望使用生產(部署的) HTTP 函數在本機 URL 上模擬託管。
firebase serve --only hosting

使用本地HTTP 函數模擬您的項目

從專案目錄執行以下任意命令以使用本機HTTP 函數模擬您的專案。

  • 若要模擬 HTTP 函數和託管以在本機 URL 上進行測試,請使用下列命令之一:

    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 託管網站的新版本
  • 新的、更新的或現有的 Firebase Cloud Functions
  • Firebase 即時資料庫的規則
  • Firebase 雲端儲存規則
  • Cloud Firestore 規則
  • Cloud Firestore 的索引

若要部署到 Firebase 項目,請從專案目錄執行以下命令:

firebase deploy

您可以選擇在每個部署中新增註解。此評論將與專案的Firebase 託管頁面上的其他部署資訊一起顯示。例如:

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錯誤訊息。若要解決此類問題,請嘗試使用部分部署

復原部署

您可以透過選擇所需版本的回溯操作,從專案的Firebase 託管頁面回溯 Firebase 託管部署。

目前無法回滾 Firebase 即時資料庫、Firebase Cloud Storage 或 Cloud Firestore 的安全規則版本。

部署特定的 Firebase 服務

如果您只想部署特定的 Firebase 服務或功能,則可以在firebase deploy命令的標誌中使用逗號分隔的清單。例如,以下命令部署 Firebase 託管內容和 Cloud Storage 安全性規則。

firebase deploy --only hosting,storage

下表列出了可用於部分部署的服務和功能。標誌中的名稱對應於firebase.json設定檔中的鍵。

標誌文法部署的服務或功能
--only hosting Firebase 託管內容
--only database Firebase 即時資料庫規則
--only storage Cloud Storage for Firebase 規則
--only firestore所有已配置資料庫的 Cloud Firestore 規則索引
--only functions Firebase 的雲端功能(此標誌的更具體版本是可能的)

部署具體功能

部署功能時,您可以針對特定功能。例如:

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

另一種選擇是將函數分組到/functions/index.js檔案中的匯出群組中。對函數進行分組可讓您使用單一命令部署多個函數。

例如,您可以編寫以下函數來定義groupAgroupB

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

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');

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。

若要設定 predeploy 或 postdeploy 掛鉤,請將 bash 腳本新增至firebase.json設定檔中。您可以直接在firebase.json檔案中定義簡短腳本,也可以引用專案目錄中的其他檔案。

例如,以下腳本是部署後任務的firebase.json表達式,該任務在成功部署到 Firebase Hosting 後發送 Slack 訊息。

"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

您可以為您可以部署的任何資產設定predeploypostdeploy掛鉤。請注意,執行firebase deploy會觸發firebase.json檔案中定義的所有部署前和部署後任務。若要僅執行與特定 Firebase 服務關聯的任務,請使用部分部署指令

predeploypostdeploy掛鉤都會將腳本的標準輸出和錯誤流印到終端。對於失敗案例,請注意以下事項:

  • 如果預部署​​掛鉤未能如預期完成,部署將被取消。
  • 如果部署因任何原因失敗,則不會觸發部署後掛鉤。

環境變數

在 predeploy 和 postdeploy 掛鉤中執行的腳本中,可以使用下列環境變數:

  • $GCLOUD_PROJECT :活動項目的項目 ID
  • $PROJECT_DIR :包含firebase.json檔案的根目錄
  • $RESOURCE_DIR :(僅適用於hostingfunctions腳本)包含要部署的託管或 Cloud Functions 資源的目錄的位置

管理多個即時資料庫實例

一個 Firebase 專案可以有多個 Firebase 即時資料庫實例。預設情況下,CLI 指令與預設資料庫實例互動。

但是,您可以使用以下命令與非預設資料庫實例進行交互--instance DATABASE_NAME標誌。以下命令支援--instance標誌:

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

命令參考

CLI 管理命令

命令描述
幫助顯示有​​關 CLI 或特定命令的協助資訊。
在裡面在目前目錄中關聯並設定一個新的 Firebase 專案。此命令在目前目錄中建立一個firebase.json設定檔。
登入對您的 Firebase 帳戶進行 CLI 驗證。需要存取網頁瀏覽器。
若要在不允許存取localhost遠端環境中登入 CLI,請使用--no-localhost標誌。
登入名稱:ci產生用於非互動式環境的身份驗證令牌。
登出從您的 Firebase 帳戶註銷 CLI。
打開開啟瀏覽器以存取相關項目資源。
項目:列表列出您有權存取的所有 Firebase 項目。
使用為 CLI 設定活動 Firebase 專案。
管理專案別名

專案管理命令

命令描述
Firebase 專案管理
專案:addfirebase將 Firebase 資源新增至現有 Google Cloud 專案。
專案:創建建立新的 Google Cloud 項目,然後將 Firebase 資源新增至新項目。
項目:列表列出您有權存取的所有 Firebase 項目。
Firebase 應用程式管理(iOS、Android、Web)
應用程式:創建在活動專案中建立一個新的 Firebase 應用程式。
應用程式:列表列出活動項目中已註冊的 Firebase 應用程式。
應用程式:sdkconfig列印 Firebase 應用程式的 Google 服務配置。
設定:網路已棄用。相反,請使用apps:sdkconfig並指定web作為平台參數。
列印 Firebase Web 應用程式的 Google 服務配置。
SHA 憑證哈希管理(僅限 Android)
應用程式:android:sha:創建\
FIREBASE_APP_ID SHA_HASH
將指定的 SHA 憑證雜湊新增至指定的 Firebase Android 應用程式。
應用程式:android:sha:刪除\
FIREBASE_APP_ID SHA_HASH
從指定的 Firebase Android 應用程式中刪除指定的 SHA 憑證雜湊。
應用程式:android:sha:列表\
FIREBASE_APP_ID
列出指定 Firebase Android 應用程式的 SHA 憑證雜湊。

部署和本地開發

這些命令可讓您部署 Firebase 託管網站並與之互動。

命令描述
部署將程式碼和資產從專案目錄部署到活動專案。對於 Firebase 託管,需要firebase.json設定檔。
服務使用您的 Firebase 託管設定啟動本機 Web 伺服器。對於 Firebase 託管,需要firebase.json設定檔。

應用程式分發命令

命令描述
appdistribution: 分發 \
--app FIREBASE_APP_ID
使建置可供測試人員使用。
應用程式分發:測試人員:添加將測試人員新增至專案。
應用程式分發:測試人員:刪除從項目中刪除測試人員。

認證(使用者管理)命令

命令描述
授權:匯出將活動項目的使用者帳戶匯出到 JSON 或 CSV 檔案。有關更多詳細信息,請參閱auth:import 和 auth:export 頁面
授權:導入將使用者帳戶從 JSON 或 CSV 檔案匯入活動項目。有關更多詳細信息,請參閱auth:import 和 auth:export 頁面

Cloud Firestore 指令

命令描述
消防庫:位置

列出 Cloud Firestore 資料庫的可用位置。

firestore:資料庫:建立DATABASE_ID

在 Firebase 專案中以本機模式建立資料庫執行個體。

該命令採用以下標誌:

  • --location <區域名稱>指定資料庫的部署位置。請注意,您可以運行firebase firestore:locations來列出可用位置。必需的
  • --delete-protection <deleteProtectionState>允許或阻止刪除指定的資料庫。有效值為ENABLEDDISABLED 。預設為DISABLED
  • --point-in-time-recovery <PITRState>設定是否啟用時間點復原。有效值為ENABLEDDISABLED 。預設為DISABLED 。選修的。
firestore:資料庫:列表

列出 Firebase 專案中的資料庫。

firestore:資料庫:取得DATABASE_ID

取得 Firebase 專案中指定資料庫的資料庫配置。

firestore:資料庫:更新DATABASE_ID

更新 Firebase 專案中指定資料庫的資料庫配置。

至少需要一個標誌。該命令採用以下標誌:

  • --delete-protection <deleteProtectionState>允許或阻止刪除指定的資料庫。有效值為ENABLEDDISABLED 。預設為DISABLED
  • --point-in-time-recovery <PITRState>設定是否啟用時間點復原。有效值為ENABLEDDISABLED 。預設為DISABLED 。選修的。
firestore:資料庫:刪除DATABASE_ID

刪除 Firebase 專案中的資料庫。

firestore:索引

列出 Firebase 專案中資料庫的索引。

該命令採用以下標誌:

  • --database DATABASE_ID指定要列出索引的資料庫的名稱。如果未提供,則列出預設資料庫的索引。
火災儲存:刪除

刪除活動項目資料庫中的文件。使用 CLI,您可以遞歸刪除集合中的所有文件。

請注意,使用 CLI 刪除 Cloud Firestore 資料會產生讀取和刪除成本。有關更多信息,請參閱了解 Cloud Firestore 計費

該命令採用以下標誌:

  • --database DATABASE_ID指定從中刪除文件的資料庫的名稱。如果未指定,則文件將從預設資料庫中刪除。選修的。

Firebase 指令的雲端函數

命令描述
功能:配置:克隆將另一個專案的環境複製到活動的 Firebase 專案中。
功能:配置:取得檢索活動項目的 Cloud Functions 的現有設定值。
功能:配置:設定儲存活動項目的 Cloud Functions 的執行時間配置值。
功能:設定:取消設定從活動項目的運行時配置中刪除值。
功能:日誌從已部署的 Cloud Functions 讀取日誌。

更多資訊請參考環境配置文件

Crashlytics 命令

命令描述
crashlytics:mappingfile:generateid \
--resource-file= PATH/TO/ANDROID_RESOURCE.XML
在指定的 Android 資源 (XML) 檔案中產生唯一的對應檔案 ID。
crashlytics:映射檔:上傳\
--app= FIREBASE_APP_ID \
--resource-file= PATH/TO/ANDROID_RESOURCE.XML \
PATH/TO/MAPPING_FILE.TXT
上傳此應用程式的 Proguard 相容映射 (TXT) 文件,並將其與指定 Android 資源 (XML) 檔案中聲明的映射檔案 ID 關聯。
crashlytics:符號:上傳 \
--app= FIREBASE_APP_ID \
PATH/TO/SYMBOLS
為 Android 上的本機程式庫崩潰產生與 Crashlytics 相容的符號文件,並將其上傳到 Firebase 伺服器。

擴充命令

命令描述
分機顯示有​​關如何使用 Firebase Extensions 命令的資訊。
列出活動項目中安裝的擴充實例。
擴充:配置\
EXTENSION_INSTANCE_ID
重新配置擴充清單中擴充實例的參數值。
分機:訊息\
PUBLISHER_ID/EXTENSION_ID
列印有關擴展的詳細資訊。
副檔名:安裝\
PUBLISHER_ID/EXTENSION_ID
將擴充功能的新實例新增到您的擴充清單中。
擴展名:列表列出 Firebase 專案中安裝的所有擴充實例。
列印每個擴充功能的實例 ID。
副檔名:卸載\
EXTENSION_INSTANCE_ID
擴充清單中刪除擴充實例。
擴充:更新\
EXTENSION_INSTANCE_ID
將擴充實例更新到擴充清單中的最新版本。
副檔名:導出將所有已安裝的擴充功能實例從項目匯出到擴充清單

擴展發布者命令

命令描述
分機:開發:初始化初始化目前目錄中新擴充的骨架程式碼庫。
分機:開發:列表 \
PUBLISHER_ID
列印發布者上傳的所有擴充功能的清單。
分機:開發:註冊將 Firebase 專案註冊為擴充發布者專案
ext:dev:棄用 \
PUBLISHER_ID/EXTENSION_ID \
VERSION_PREDICATE
棄用與版本謂詞相符的擴充版本。
版本謂詞可以是單一版本(例如1.0.0 ),也可以是一系列版本(例如>1.0.0 )。
如果未提供版本謂詞,則棄用該擴充功能的所有版本。
ext:dev:不建議使用 \
PUBLISHER_ID/EXTENSION_ID \
VERSION_PREDICATE
取消棄用與版本謂詞相符的擴充版本。
版本謂詞可以是單一版本(例如1.0.0 ),也可以是一系列版本(例如>1.0.0 )。
如果未提供版本謂詞,則取消棄用該擴充功能的所有版本。
分機:dev:上傳\
PUBLISHER_ID/EXTENSION_ID
上傳新版本的擴充功能。
分機:開發:用法 \
PUBLISHER_ID
顯示發布者上傳的擴充功能的安裝計數和使用指標。

託管命令

命令描述
託管:停用

停止為活動的 Firebase 專案提供 Firebase 託管流量。

執行此命令後,您的專案的託管 URL 將顯示「未找到網站」訊息。

託管網站的管理
firebase 託管:網站:建立 \
SITE_ID

使用指定的SITE_ID在活動 Firebase 專案中建立新的託管站點

(可選)透過傳遞以下標誌來指定要與新網站關聯的現有 Firebase Web 應用程式: --app FIREBASE_APP_ID

firebase 託管:網站:刪除 \
SITE_ID

刪除指定的託管站點

CLI 在刪除網站之前會顯示確認提示。

(可選)透過傳遞以下標誌來跳過確認提示: -f--force

firebase 託管:網站:取得 \
SITE_ID

檢索指定託管網站的信息

firebase 託管:網站:列表

列出活動 Firebase 專案的所有託管站點

預覽頻道管理
firebase 託管:頻道:建立 \
CHANNEL_ID

使用指定的CHANNEL_ID預設託管網站中建立新的預覽頻道

此命令不會部署到通道。

firebase 託管:頻道:刪除 \
CHANNEL_ID

刪除指定預覽頻道

您無法刪除站點的直播頻道。

firebase 託管:通道:部署 \
CHANNEL_ID

將您的託管內容和配置部署到指定的預覽頻道

如果預覽頻道尚不存在,此命令會在部署到頻道之前在預設託管網站中建立頻道。

firebase 託管:頻道:列表列出預設託管網站中的所有頻道(包括「直播」頻道)
firebase 託管:通道:開啟 \
CHANNEL_ID
開啟瀏覽器到指定頻道的 URL,如果無法在瀏覽器中打開,則傳回 URL
版本克隆
firebase 託管:複製 \
SOURCE_SITE_ID : SOURCE_CHANNEL_ID \
TARGET_SITE_ID TARGET_CHANNEL_ID

將指定「來源」通道上最近部署的版本複製到指定「目標」通道

該命令也部署到指定的「目標」通道。如果「目標」頻道尚不存在,則該命令將在部署到頻道之前在「目標」託管網站中建立新的預覽通道。

燃箱託管:克隆\
SOURCE_SITE_ID :@ VERSION_ID \
TARGET_SITE_ID TARGET_CHANNEL_ID

複製指定的「目標」通道的指定版本

該命令也部署到指定的「目標」通道。如果「目標」頻道尚不存在,則該命令將在部署到頻道之前在「目標」託管網站中建立新的預覽通道。

您可以在Firebase控制台的託管儀表板中找到VERSION_ID

即時資料庫指令

請注意,您可以在Firebase控制台中建立初始的,預設的即時資料庫實例,也可以使用常規firebase init Workflow或特定的firebase init database流。

建立執行個體後,您可以依照管理多個即時資料庫執行個體進行管理。

命令描述
資料庫:取得從Active Project的資料庫中取得數據,並將其顯示為JSON。支援查詢索引資料。
資料庫:實例:創建使用指定的實例名稱建立資料庫實例。接受在指定區域中建立資料庫的--location選項。有關此選項的區域名稱,請參閱項目的選擇位置。如果目前專案不存在資料庫實例,則提示您執行firebase init流以建立實例。
資料庫:實例:列表列出此項目的所有資料庫實例。接受用於在指定區域中列出資料庫的--location選項。有關此選項的區域名稱,請參閱您項目的選擇位置
資料庫:設定檔在Active Project的資料庫上建立操作設定檔。有關更多詳細信息,請參閱實時數據庫操作類型
資料庫:推將新資料推入Active Project資料庫中指定位置的清單。從文件,stdin或命令列參數中獲取輸入。
資料庫:刪除刪除Active Project資料庫中指定位置的所有資料。
資料庫:設定替換Active Project資料庫中指定位置的所有資料。從文件,stdin或命令列參數中獲取輸入。
資料庫:更新在Active Project資料庫中指定的位置執行部分更新。從文件,stdin或命令列參數中獲取輸入。

遠端配置命令

命令描述
remoteconfig:版本:List \
- limit NUMBER_OF_VERSIONS
列出了模板的最新十個版本。指定0返回所有現有版本,或選擇傳遞--limit選項以限制傳回的版本的數量。
remoteconfig:獲取\
-v,version_number VERSION_NUMBER
- o,輸出FILENAME
按版本取得範本(預設為最新版本),然後將參數組,參數和條件名稱和版本輸出到表中。可選地,您可以將輸出寫入帶有-o, FILENAME的指定檔案。
remoteconfig:回滾\
-v,version_number VERSION_NUMBER
- 力量
將遠端設定範本捲動為指定的先前版本號或預設為即時上一個版本(目前版本-1)。除非通過--force通過,請在繼續回滾之前提示y/n