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

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

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

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

安装和源代码

使用cargo安装命令行界面

cargo install google-plusdomains1-cli

在GitHub上找到源代码。

用法

此文档是从plusDomains API的20190616版本生成的。CLI版本为5.0.4。

plusdomains1 [options]
        activities
                get <activity-id> [-p <v>]... [-o <out>]
                list <user-id> <collection> [-p <v>]... [-o <out>]
        audiences
                list <user-id> [-p <v>]... [-o <out>]
        circles
                list <user-id> [-p <v>]... [-o <out>]
        comments
                get <comment-id> [-p <v>]... [-o <out>]
                list <activity-id> [-p <v>]... [-o <out>]
        media
                insert <user-id> <collection> (-r <kv>)... (-u simple -f <file> [-m <mime>]) [-p <v>]... [-o <out>]
        people
                get <user-id> [-p <v>]... [-o <out>]
                list <user-id> <collection> [-p <v>]... [-o <out>]
                list-by-activity <activity-id> <collection> [-p <v>]... [-o <out>]
  plusdomains1 --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文件中，以plusdomains1-为前缀。您可以使用--config-dir标志在每次调用中更改用于存储配置的目录。

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

身份验证

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

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

首次使用作用域时，系统会询问用户权限。按照CLI指令授予权限或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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