该people1命令行界面（CLI）允许您从终端舒适地使用Google People服务的大部分功能。

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

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

有关People服务API的所有其他信息，请参阅官方文档网站。

安装和源代码

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

cargo install google-people1-cli

在github上找到源代码。

用法

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

people1 [options]
        contact-groups
                batch-get [-p <v>]... [-o <out>]
                create (-r <kv>)... [-p <v>]... [-o <out>]
                delete <resource-name> [-p <v>]... [-o <out>]
                get <resource-name> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                members-modify <resource-name> (-r <kv>)... [-p <v>]... [-o <out>]
                update <resource-name> (-r <kv>)... [-p <v>]... [-o <out>]
        other-contacts
                copy-other-contact-to-my-contacts-group <resource-name> (-r <kv>)... [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                search [-p <v>]... [-o <out>]
        people
                batch-create-contacts (-r <kv>)... [-p <v>]... [-o <out>]
                batch-delete-contacts (-r <kv>)... [-p <v>]... [-o <out>]
                batch-update-contacts (-r <kv>)... [-p <v>]... [-o <out>]
                connections-list <resource-name> [-p <v>]... [-o <out>]
                create-contact (-r <kv>)... [-p <v>]... [-o <out>]
                delete-contact <resource-name> [-p <v>]... [-o <out>]
                delete-contact-photo <resource-name> [-p <v>]... [-o <out>]
                get <resource-name> [-p <v>]... [-o <out>]
                get-batch-get [-p <v>]... [-o <out>]
                list-directory-people [-p <v>]... [-o <out>]
                search-contacts [-p <v>]... [-o <out>]
                search-directory-people [-p <v>]... [-o <out>]
                update-contact <resource-name> (-r <kv>)... [-p <v>]... [-o <out>]
                update-contact-photo <resource-name> (-r <kv>)... [-p <v>]... [-o <out>]
  people1 --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文件中，文件以people1-为前缀。您可以使用--config-dir标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

当首次使用作用域时，会要求用户授权。按照 CLI 指示授权或拒绝。

如果用户已对作用域进行身份验证，相应的信息将作为 JSON 存储在配置目录中，例如 ~/.google-service-cli/people1-token-<scope-hash>.json。无需手动管理这些令牌。

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

应用程序密钥

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

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

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

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

调试

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

使用 --debug 标志将在标准错误中使用 Debug 表示形式打印错误。

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