Firebase CLI

Firebase 命令行界面 (CLI) 工具可用于从命令行测试、管理和部署您的 Firebase 项目。

• 将代码和资产部署到您的 Firebase 项目
• 为您的 Firebase Hosting 站点运行本地 Web 服务器
• 与 Firebase 数据库中的数据交互
• 将用户导入/导出到 Firebase Auth

要开始使用 Firebase CLI，请阅读下面的完整命令列表或查看文档。

安装

Node 包

您可以使用 npm（Node 包管理器）安装 Firebase CLI。请注意，您需要安装 Node.js 和 npm。安装 Node.js 应该也会安装 npm。

要下载并安装 Firebase CLI，请运行以下命令：

npm install -g firebase-tools

这将为您提供全局可访问的 firebase 命令。

独立二进制文件

Firebase CLI 的独立二进制发行版允许您下载不依赖任何其他组件的 firebase 可执行文件。

要下载并安装 CLI，请运行以下命令：

curl -sL firebase.tools | bash

命令

命令 firebase --help 列出可用的命令，而 firebase <command> --help 显示单个命令的更多详细信息。

如果命令是特定于项目的，您必须位于具有活动项目别名的项目目录中，或使用 -P <project_id> 标志指定 Firebase 项目 ID。

以下是可用命令及其功能的简要列表：

配置命令

在登录命令后附加 --no-localhost（即 firebase login --no-localhost）以复制和粘贴代码，而不是启动本地服务器进行身份验证。一个用例可能是当您 SSH 到某个实例时，需要在该机器上向 Firebase 进行身份验证。

项目管理命令

部署和本地模拟

这些命令让您可以部署和与 Firebase 服务交互。

应用分发命令

认证命令

详细文档在这里。

实时数据库命令

扩展命令

Cloud Firestore 命令

Cloud Functions 命令

托管命令

远程配置命令

使用firebase:deploy --only remoteconfig更新并发布项目的Firebase远程配置模板。

认证

一般情况

Firebase CLI可以使用以下四种认证方法之一，按优先级降序排列：

• 用户令牌 - 已弃用：此认证方法将在firebase-tools的未来主要版本中移除；请改用服务账号进行认证 - 提供从firebase login:ci生成的显式长期Firebase用户令牌。请注意，这些令牌是极其敏感的长期凭证，在大多数情况下并不是正确的选择。请考虑使用服务账号授权。可以通过以下两种方式设置令牌：
  • 在任何命令上设置--token标志，例如firebase --token="<token>" projects:list。
  • 设置FIREBASE_TOKEN环境变量。
• 本地登录 - 运行firebase login直接以自己的身份登录CLI。CLI将在您的机器上缓存授权用户凭证。
• 服务账号 - 设置GOOGLE_APPLICATION_CREDENTIALS环境变量指向JSON服务账号密钥文件的路径。有关更多详细信息，请参阅Google Cloud的身份验证入门指南。
• 应用程序默认凭证 - 如果您使用gcloud CLI并使用gcloud auth application-default login登录，在没有上述凭证的情况下，Firebase CLI将使用它们。

多个账号

默认情况下，firebase login设置一个用于所有项目的全局账号。 如果您有多个用于Firebase项目的Google账号，可以授权多个账号并在每个项目或每个命令的基础上使用它们。

要为CLI授权额外的账号，请运行firebase login:add。 您可以使用firebase login:list查看授权账号列表。

要为特定的Firebase项目目录设置默认账号，请在目录中运行 firebase login:use并选择所需的账号。 要检查目录的默认账号，请运行firebase login:list，当前上下文的 默认账号将列在第一位。

要为特定的命令调用设置账号，请在任何命令中使用--account标志。 例如firebase --account=user@domain.com deploy。 指定的账号必须已使用firebase login:add添加到Firebase CLI中。

云函数模拟器

云函数模拟器通过emulators:start、 serve和functions:shell等命令公开。模拟的云函数作为独立的node进程 在您的开发机器上运行，这意味着它们有自己的凭证发现机制。

默认情况下，这些node进程无法发现来自firebase login的凭证。 为了提供更好的开发体验，当您通过firebase login登录CLI时， 我们会获取用户凭证并构造一个临时凭证， 通过GOOGLE_APPLICATION_CREDENTIALS传递给模拟器。我们仅在 您尚未自行设置GOOGLE_APPLICATION_CREDENTIALS环境变量时执行此操作。

在代理后使用

CLI通过环境变量支持HTTP(S)代理。要使用代理，请在您的环境中设置HTTPS_PROXY 或HTTP_PROXY值为代理的URL（例如 HTTP_PROXY=http://127.0.0.1:12345）。

在CI系统中使用

Firebase CLI需要浏览器来完成认证，但完全 兼容CI和其他无头环境。

完成以下步骤以在CI环境中运行Firebase命令。在Google Cloud的身份验证入门指南中可以找到每个步骤的详细说明。

1. 创建一个服务账号并授予其对项目的适当访问级别。
2. 为该服务账号创建一个服务账号密钥（JSON文件）。
3. 以安全、可访问的方式在CI系统中存储密钥文件。
4. 在运行Firebase命令时，在CI系统中设置GOOGLE_APPLICATION_CREDENTIALS=/path/to/key.json。

要禁用服务账号的访问权限，请在Google Cloud控制台中查找服务账号，然后删除密钥，或禁用或删除服务账号。

作为模块使用

Firebase CLI也可以作为标准Node模块以编程方式使用。 每个命令都作为一个函数公开，该函数接受位置参数，后跟一个选项对象，并返回一个Promise。

因此，如果我们在命令行运行以下命令：

$ firebase --project="foo" apps:list ANDROID

这在Node中转换为以下内容：

const client = require("firebase-tools");
client.apps
  .list("ANDROID", { project: "foo" })
  .then((data) => {
    // ...
  })
  .catch((err) => {
    // ...
  });

选项对象必须是最后一个参数，任何未指定的 位置参数将获得默认值""。以下 两个调用是等效的：

const client = require("firebase-tools");

// #1 - 无参数或选项，将推断默认值
client.apps.list();

// #2 - 显式为所有参数提供""，为选项提供{}
client.apps.list("", {});

注意：在云函数等受限环境中使用时，并非所有firebase-tools命令都能以编程方式工作， 因为它们需要访问本地文件系统。