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

5.0.4+20240224 2024年3月5日
3.1.0+20220301 2022年4月26日
3.0.0+20220301 2022年3月8日
2.0.4+20210322 2021年4月14日
1.0.8+20181009 2018年10月14日

#2603 in 网络编程

Download history 22/week @ 2024-03-08 3/week @ 2024-03-15 88/week @ 2024-03-29 18/week @ 2024-04-05 2/week @ 2024-05-17 1/week @ 2024-05-24

每月251次下载

MIT 协议

155KB
2K SLoC

digitalassetlinks1 命令行界面(CLI)允许您从终端舒适地使用Google数字资产链接服务的几乎所有功能。

默认情况下,所有输出都打印到标准输出,但可以通过设置标志将其重定向到文件,而无需依赖shell的功能。错误将打印到标准错误,并将导致程序的退出码非零。

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

有关数字资产链接API的所有其他信息,请参阅官方文档网站

安装和源代码

使用cargo通过以下方式安装命令行界面:

cargo install google-digitalassetlinks1-cli

GitHub上找到源代码。

用法

本文档是从修订版 20240224digitalassetlinks API生成的。CLI的版本是 5.0.4

digitalassetlinks1 [options]
        assetlinks
                bulk-check (-r <kv>)... [-p <v>]... [-o <out>]
                check [-p <v>]... [-o <out>]
        statements
                list [-p <v>]... [-o <out>]
  digitalassetlinks1 --help

Configuration:
  --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 文件中,文件名以 digitalassetlinks1- 开头。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

首次使用作用域时,系统会请求用户授权。按照CLI的指示授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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

依赖项

~20–32MB
~584K SLoC