该 essentialcontacts1 命令行界面（CLI）允许您从终端舒适地使用 Google Essentialcontacts 服务的多数功能。

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

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

有关 Essentialcontacts API 的其他信息，请参阅官方文档网站。

安装和源代码

使用 cargo 安装命令行界面：

cargo install google-essentialcontacts1-cli

在 GitHub 上找到源代码。

用法

本文档是从 Essentialcontacts API 的 20240223 版本生成的。CLI 版本为 5.0.4。

essentialcontacts1 [options]
        folders
                contacts-compute <parent> [-p <v>]... [-o <out>]
                contacts-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                contacts-delete <name> [-p <v>]... [-o <out>]
                contacts-get <name> [-p <v>]... [-o <out>]
                contacts-list <parent> [-p <v>]... [-o <out>]
                contacts-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                contacts-send-test-message <resource> (-r <kv>)... [-p <v>]... [-o <out>]
        organizations
                contacts-compute <parent> [-p <v>]... [-o <out>]
                contacts-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                contacts-delete <name> [-p <v>]... [-o <out>]
                contacts-get <name> [-p <v>]... [-o <out>]
                contacts-list <parent> [-p <v>]... [-o <out>]
                contacts-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                contacts-send-test-message <resource> (-r <kv>)... [-p <v>]... [-o <out>]
        projects
                contacts-compute <parent> [-p <v>]... [-o <out>]
                contacts-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                contacts-delete <name> [-p <v>]... [-o <out>]
                contacts-get <name> [-p <v>]... [-o <out>]
                contacts-list <parent> [-p <v>]... [-o <out>]
                contacts-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                contacts-send-test-message <resource> (-r <kv>)... [-p <v>]... [-o <out>]
  essentialcontacts1 --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 文件中，文件名以 essentialcontacts1- 开头。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

第一次使用作用域时，系统会要求用户授权。按照CLI的指示进行授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

使用--debug标志会将错误以Debug表示形式打印到标准错误。

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