groupssettings1 命令行界面 (CLI) 允许您在终端中方便地使用Google groupssettings服务的多数功能。

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

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

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

安装和源代码

使用cargo安装命令行界面

cargo install google-groupssettings1-cli

在GitHub上找到源代码。

用法

本文档是根据groupssettings API的修订版20220614生成的。CLI的版本为5.0.4。

groupssettings1 [options]
        groups
                get <group-unique-id> [-p <v>]... [-o <out>]
                patch <group-unique-id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <group-unique-id> (-r <kv>)... [-p <v>]... [-o <out>]
  groupssettings1 --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目录中存储所有持久数据，其中以groupssettings1为前缀的JSON文件。您可以使用--config-dir标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

首次使用范围时，系统会要求用户授权。按照CLI提供的说明授权权限或拒绝。

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

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

应用程序密钥

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

为了使CLI更便于使用，而不必强迫任何人注册自己的应用程序，CLI自带了一个默认的应用程序密钥，并进行相应配置。这也意味着全球范围内的重用可能会耗尽每日配额。

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

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

调试

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

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

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