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

5.0.4+20240304 2024年3月5日
3.1.0+20220307 2022年4月26日
3.0.0+20220307 2022年3月8日
2.0.4+20210331 2021年4月15日
1.0.14+20200603 2020年7月10日

#2514 in 网络编程

Download history 7/week @ 2024-03-11 65/week @ 2024-04-01

每月下载量:130

MIT 协议

215KB
3K SLoC

domainsrdap1 命令行界面(CLI)允许您在终端舒适地使用Google Domains RDAP服务的多数功能。

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

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

有关Domains RDAP API的所有其他信息,请参阅官方文档网站

安装和源代码

使用cargo安装命令行界面:

cargo install google-domainsrdap1-cli

GitHub上找到源代码。

用法

本文档是从Domains RDAP API的20240304修订版生成的。CLI版本为5.0.4

domainsrdap1 [options]
        autnum
                get <autnum-id> [-p <v>]... [-o <out>]
        domain
                get <domain-name> [-p <v>]... [-o <out>]
        entity
                get <entity-id> [-p <v>]... [-o <out>]
        ip
                get <ip-id> <ip-id1> [-p <v>]... [-o <out>]
        methods
                get-domains [-p <v>]... [-o <out>]
                get-entities [-p <v>]... [-o <out>]
                get-help [-p <v>]... [-o <out>]
                get-ip [-p <v>]... [-o <out>]
                get-nameservers [-p <v>]... [-o <out>]
        nameserver
                get <nameserver-id> [-p <v>]... [-o <out>]
  domainsrdap1 --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文件中,以domainsrdap1-开头。您可以使用--config-dir标志在每次调用中更改用于存储配置的目录。

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

身份验证

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

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

第一次使用范围时,会询问用户权限。根据CLI的说明授予权限或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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

依赖关系

~20–31MB
~581K SLoC