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

应用 google-area120tables1_alpha1-cli

用于与 Area120 Tables(协议 v1alpha1)交互的完整库

6 个稳定版本

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

#2951 in 网络编程

Download history 2/week @ 2024-04-07 1/week @ 2024-05-19

每月105 次下载

MIT 许可证

315KB
4.5K SLoC

area120tables1-alpha1 命令行界面(CLI)允许您从终端舒适地使用 Google Area120 Tables 服务的多数功能。

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

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

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

安装和源代码

使用 cargo 安装命令行界面:

cargo install google-area120tables1_alpha1-cli

github 上找到源代码。

用法

此文档是根据修订版 20240304 的 Area120 Tables API 生成的。CLI 版本为 5.0.4

area120tables1-alpha1 [options]
        tables
                get <name> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                rows-batch-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                rows-batch-delete <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                rows-batch-update <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                rows-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                rows-delete <name> [-p <v>]... [-o <out>]
                rows-get <name> [-p <v>]... [-o <out>]
                rows-list <parent> [-p <v>]... [-o <out>]
                rows-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
        workspaces
                get <name> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
  area120tables1-alpha1 --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 文件中,文件名以 area120tables1-alpha1- 开头。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

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

如果用户验证了作用域,相关数据将以JSON格式存储在配置目录中,例如:~/.google-service-cli/area120tables1-alpha1-token-<scope-hash>.json。无需手动管理这些令牌。

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

应用程序密钥

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

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

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

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

调试

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

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

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

依赖关系

~20–31MB
~577K SLoC