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

app google-vectortile1-cli

用于与语义瓦片(协议v1)交互的完整库

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

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

#2748 in 网络编程

MIT 协议

160KB
2K SLoC

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

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

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

有关语义瓦片API的其他一切信息,请参阅官方文档网站

安装和源代码

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

cargo install google-vectortile1-cli

GitHub上找到源代码

用法

本文档是从修订版20210331的语义瓦片API生成的。CLI版本为5.0.4

vectortile1 [options]
        featuretiles
                get <name> [-p <v>]... [-o <out>]
        terraintiles
                get <name> [-p <v>]... [-o <out>]
  vectortile1 --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文件中,文件名以vectortile1-为前缀。您可以通过--config-dir标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

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

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

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

应用程序密钥

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

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

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

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

调试

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

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

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

依赖项

~20–31MB
~581K SLoC