chat1命令行界面（CLI）允许您从终端舒适地使用Google Hangouts Chat服务的几乎所有功能。

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

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

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

安装和源代码

使用cargo安装命令行界面

cargo install google-chat1-cli

在GitHub上找到源代码。

用法

此文档是从Hangouts Chat API的20210324修订版生成的。CLI版本为2.0.4。

chat1 [options]
        dms
                conversations-messages <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                messages <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                webhooks <parent> (-r <kv>)... [-p <v>]... [-o <out>]
        media
                download <resource-name> [-p <v>]... [-o <out>]
        rooms
                conversations-messages <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                messages <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                webhooks <parent> (-r <kv>)... [-p <v>]... [-o <out>]
        spaces
                get <name> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                members-get <name> [-p <v>]... [-o <out>]
                members-list <parent> [-p <v>]... [-o <out>]
                messages-attachments-get <name> [-p <v>]... [-o <out>]
                messages-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                messages-delete <name> [-p <v>]... [-o <out>]
                messages-get <name> [-p <v>]... [-o <out>]
                messages-update <name> (-r <kv>)... [-p <v>]... [-o <out>]
                webhooks <parent> (-r <kv>)... [-p <v>]... [-o <out>]
  chat1 --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文件中，文件以chat1开头。您可以使用--config-dir标志在每次调用中更改用于存储配置的目录。

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

身份验证

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

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

首次使用作用域时，系统会要求用户授权。按照CLI的说明授予权限或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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