#google-api #spectrum #google #cli #command-line-interface

应用 google-spectrum1_explorer-cli

一个完整的库,用于与频谱(协议v1explorer)交互

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

5.0.4+20170306 2024年3月5日
3.0.0+20170306 2022年3月8日
2.0.4+20170306 2021年4月15日
1.0.14+20170306 2020年7月10日
0.3.6+20160606 2016年9月11日

##2314 in 网络编程

Download history 27/week @ 2024-03-08 4/week @ 2024-03-15 99/week @ 2024-03-29 26/week @ 2024-04-05

438 每月下载次数

MIT 许可证

255KB
3K SLoC

spectrum1-explorer 命令行界面(CLI)允许您从终端舒适地使用Google频谱服务的几乎所有功能。

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

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

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

安装和源代码

使用cargo安装命令行界面

cargo install google-spectrum1_explorer-cli

GitHub上找到源代码

用法

此文档是从修订版 20170306spectrum API生成的。CLI版本为 5.0.4

spectrum1-explorer [options]
        paws
                get-spectrum (-r <kv>)... [-p <v>]... [-o <out>]
                get-spectrum-batch (-r <kv>)... [-p <v>]... [-o <out>]
                init (-r <kv>)... [-p <v>]... [-o <out>]
                notify-spectrum-use (-r <kv>)... [-p <v>]... [-o <out>]
                register (-r <kv>)... [-p <v>]... [-o <out>]
                verify-device (-r <kv>)... [-p <v>]... [-o <out>]
  spectrum1-explorer --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 文件中,文件名以 spectrum1-explorer- 开头。您可以使用 --config-dir 标志在每次调用中更改用于存储配置的目录。

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

身份验证

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

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

第一次使用范围时,用户将被要求授权。按照 CLI 的指示授权或拒绝。

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

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

应用程序密钥

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

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

您可以通过将您的密钥文件放在此位置来解决这个问题:~/.google-service-cli/spectrum1-explorer-secret.json,前提是已为其启用了所需的 spectrum API。这样的密钥文件可以在 Google 开发者控制台APIs & auth -> Credentials -> Download JSON 中下载并直接使用。

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

调试

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

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

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

依赖关系

~20–31MB
~581K SLoC