#google #cli #google-api #firebasedynamiclinks

app google-firebasedynamiclinks1-cli

一个完整的库,用于与 Firebase Dynamic Links (协议 v1) 交互

21 个稳定版本 (3 个主要版本)

5.0.4+20240226 2024年3月5日
3.1.0+20220228 2022年4月26日
3.0.0+20220228 2022年3月8日
2.0.4+20210329 2021年4月15日
1.0.2+20161118 2016年12月27日

#183 in #cli

MIT 许可证

225KB
3K SLoC

firebasedynamiclinks1 命令行界面 (CLI) 允许您从终端舒适地使用 Google Firebase Dynamic Links 服务的几乎所有功能。

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

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

有关 Firebase Dynamic Links API 的其他信息,请参阅 官方文档站点

安装和源代码

使用 cargo 安装命令行界面

cargo install google-firebasedynamiclinks1-cli

GitHub 上查找源代码。

用法

此文档是根据 Firebase Dynamic Links API 的 20240226 版本生成的。CLI 版本为 5.0.4

firebasedynamiclinks1 [options]
        managed-short-links
                create (-r <kv>)... [-p <v>]... [-o <out>]
        methods
                get-link-stats <dynamic-link> [-p <v>]... [-o <out>]
                install-attribution (-r <kv>)... [-p <v>]... [-o <out>]
                reopen-attribution (-r <kv>)... [-p <v>]... [-o <out>]
        short-links
                create (-r <kv>)... [-p <v>]... [-o <out>]
  firebasedynamiclinks1 --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 目录中,以 firebasedynamiclinks1- 开头的 JSON 文件中。您可以使用 --config-dir 标志根据调用更改用于存储配置的目录。

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

身份验证

大多数 API 需要用户对任何请求进行身份验证。如果是这样,作用域 确定了授予的权限集。这些通常是仅限于 只读完全访问

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

第一次使用作用域时,系统会要求用户授予权限。根据 CLI 提供的说明授予权限或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

尽管CLI尽力提供可用的错误消息,但有时可能希望知道导致特定问题确切原因。这是通过允许所有客户端-服务器通信输出到标准错误不变来完成的。

--debug标志将以Debug表示形式将错误打印到标准错误。

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

依赖关系

~20–31MB
~576K SLoC