#google-api #google #cli #command-line-interface #site-verification

app google-siteverification1-cli

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

20 个稳定版本 (4 个主要版本)

5.0.4+20191119 2024年3月5日
3.1.0+20191119 2022年4月26日
3.0.0+20191119 2022年3月8日
2.0.4+20191119 2021年4月15日
0.3.6+20160228 2016年9月11日

#2473 in 网络编程

MIT 许可证

205KB
3K SLoC

siteverification1 命令行界面(CLI)允许您从终端舒适地使用 Google siteVerification 服务的大部分功能。

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

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

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

安装和源代码

使用 cargo 安装命令行界面:

cargo install google-siteverification1-cli

GitHub 上查找源代码。

用法

此文档是从 siteVerification API(修订版 20191119)生成的。CLI 版本为 5.0.4

siteverification1 [options]
        web-resource
                delete <id> [-p <v>]...
                get <id> [-p <v>]... [-o <out>]
                get-token (-r <kv>)... [-p <v>]... [-o <out>]
                insert <verification-method> (-r <kv>)... [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                patch <id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <id> (-r <kv>)... [-p <v>]... [-o <out>]
  siteverification1 --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 目录中存储所有持久数据,该目录以 siteverification1- 前缀的 JSON 文件开头。您可以使用 --config-dir 标志根据调用更改用于存储配置的目录。

有关各种持久数据的更多信息,请参阅以下段落。

身份验证

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

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

第一次使用范围时,会要求用户授权。根据CLI的说明授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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

依赖关系

~20–31MB
~584K SLoC