6个稳定版本

5.0.4+20240303 2024年3月5日
3.1.0+20220305 2022年4月26日
3.0.0+20220305 2022年3月8日
2.0.4+20210330 2021年4月15日

#15 in #cli-interface

Download history 1/week @ 2024-05-20

112 每月下载量

MIT许可证

140KB
2K SLoC

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

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

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

有关Localservices API的更多信息,请参阅官方文档网站

安装和源代码

使用cargo安装命令行界面

cargo install google-localservices1-cli

GitHub上找到源代码

用法

本文档是从修订版20240303的Localservices API生成的。CLI版本为5.0.4

localservices1 [options]
        account-reports
                search [-p <v>]... [-o <out>]
        detailed-lead-reports
                search [-p <v>]... [-o <out>]
  localservices1 --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目录中的JSON文件中,文件以localservices1-开头。您可以使用--config-dir标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

第一次使用作用域时,用户将被要求授权。根据CLI的说明授予权限或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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

依赖项

~20–31MB
~580K SLoC