firebaseml1 命令行界面 (CLI) 允许您在终端中方便地使用 Google Firebase ML 服务的多数功能。

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

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

有关 Firebase ML API 的其他所有信息，请参阅官方文档站点。

安装和源代码

使用 cargo 安装命令行界面：

cargo install google-firebaseml1-cli

在GitHub上查找源代码。

用法

此文档是从修订版 20240221 的 Firebase ML API 生成的。CLI 版本为 5.0.4。

firebaseml1 [options]
        operations
                cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                delete <name> [-p <v>]... [-o <out>]
                list <name> [-p <v>]... [-o <out>]
  firebaseml1 --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 文件中，文件名以 firebaseml1 开头。您可以使用 --config-dir 标志在每次调用中更改用于存储配置的目录。

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

身份验证

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

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

首次使用作用域时，会要求用户授权。按照CLI给出的指示授权或拒绝。

如果用户认证了作用域，相应的信息将作为JSON存储在配置目录中，例如~/.google-service-cli/firebaseml1-token-<scope-hash>.json。不需要手动管理这些令牌。

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

应用程序密钥

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

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

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

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

调试

尽管CLI尽力提供可用的错误消息，但有时可能需要知道导致特定问题的确切原因。这是通过允许所有客户端-服务器通信以原始形式输出到标准错误。

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

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