fcm1 命令行界面（CLI）允许您从终端舒适地使用 Google Firebase 云消息（Google Firebase Cloud Messaging）服务的大部分功能。

默认情况下，所有输出都打印到标准输出，但可以通过设置标志将其直接重定向到文件，而不受您的 shell 功能的限制。错误将打印到标准错误，并导致程序的退出代码不为零。

如果请求数据结构，这些结构将作为格式化的 JSON 返回，以便作为其他工具的输入。

有关 Firebase 云消息 API 的其他信息，请参阅官方文档网站。

安装和源代码

使用 cargo 安装命令行界面

cargo install google-fcm1-cli

在 GitHub 上找到源代码。

用法

本文档是根据 Firebase 云消息 API 的修订版 20240227 生成的。CLI 的版本是 5.0.4。

fcm1 [options]
        projects
                messages-send <parent> (-r <kv>)... [-p <v>]... [-o <out>]
  fcm1 --help

Configuration:
  [--scope <url>]...
            Specify the authentication a method should be executed in. Each scope
            requires the user to grant this application permission to use it.
            If unset, it defaults to the shortest scope url for a particular method.
  --config-dir <folder>
            A directory into which we will store our persistent data. Defaults to
            a user-writable directory that we will create during the first invocation.
            [default: ~/.google-service-cli]

配置

程序将所有持久数据存储在 ~/.google-service-cli 目录中的 JSON 文件中，文件名以 fcm1- 开头。您可以使用 --config-dir 标志在每个调用中更改用于存储配置的目录。

以下段落提供了有关各种类型持久数据的更多信息。

身份验证

大多数 API 需要用户对任何请求进行身份验证。如果是这种情况，作用域 确定了授予的权限集。这些的粒度通常不超过 只读 或 完全访问。

如果没有设置，系统将自动选择最小的可行范围，例如调用只读方法时，它只会请求只读范围。您可以使用--scope标志直接指定范围。所有适用范围都在各自方法的CLI文档中记录。

首次使用范围时，会询问用户权限。按照CLI给出的指示授权或拒绝权限。

如果用户已认证范围，相关信息将以JSON格式存储在配置目录中，例如~/.google-service-cli/fcm1-token-<scope-hash>.json。无需手动管理这些令牌。

要撤销授权的认证，请参阅官方文档。

应用程序密钥

为了允许任何应用程序使用Google服务，它需要使用Google开发者控制台进行注册。应用程序可能使用的API将逐个启用。大多数API可以免费使用，并且有每日配额。

为了在不强制任何人注册自己的应用程序的情况下更方便地使用CLI，CLI自带了一个默认应用程序密钥，并根据需要进行配置。这也意味着全球范围内的重用可能会耗尽每日配额。

您可以通过将您自己的密钥文件放置在此位置来解决这个问题：~/.google-service-cli/fcm1-secret.json，假设已为它启用了所需的fcm API。此类密钥文件可以从Google开发者控制台在APIs & auth -> Credentials -> Download JSON处下载，并直接使用。

有关如何设置Google项目和启用API的更多信息，请参阅官方文档。

调试

尽管CLI尽力提供可用的错误消息，但有时了解导致特定问题的确切原因可能是可取的。这是通过允许所有客户端服务器通信以标准错误直接输出来实现的。

使用--debug标志将错误以Debug表示法打印到标准错误。

您可以将标准错误重定向到文件，以便于使用，例如fcm1 --debug <resource> <method> [options] 2>debug.txt。