pubsub1 命令行界面 (CLI) 允许您从终端舒适地使用 Google Pubsub 服务的大部分功能。

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

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

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

安装和源代码

使用 cargo 安装命令行界面：

cargo install google-pubsub1-cli

在 github 上找到源代码。

用法

本文档是从 Pubsub API 的 20240227 修订版生成的。CLI 版本为 5.0.4。

pubsub1 [options]
        projects
                schemas-commit <name> (-r <kv>)... [-p <v>]... [-o <out>]
                schemas-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                schemas-delete <name> [-p <v>]... [-o <out>]
                schemas-delete-revision <name> [-p <v>]... [-o <out>]
                schemas-get <name> [-p <v>]... [-o <out>]
                schemas-get-iam-policy <resource> [-p <v>]... [-o <out>]
                schemas-list <parent> [-p <v>]... [-o <out>]
                schemas-list-revisions <name> [-p <v>]... [-o <out>]
                schemas-rollback <name> (-r <kv>)... [-p <v>]... [-o <out>]
                schemas-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                schemas-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                schemas-validate <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                schemas-validate-message <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                snapshots-create <name> (-r <kv>)... [-p <v>]... [-o <out>]
                snapshots-delete <snapshot> [-p <v>]... [-o <out>]
                snapshots-get <snapshot> [-p <v>]... [-o <out>]
                snapshots-get-iam-policy <resource> [-p <v>]... [-o <out>]
                snapshots-list <project> [-p <v>]... [-o <out>]
                snapshots-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                snapshots-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                snapshots-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                subscriptions-acknowledge <subscription> (-r <kv>)... [-p <v>]... [-o <out>]
                subscriptions-create <name> (-r <kv>)... [-p <v>]... [-o <out>]
                subscriptions-delete <subscription> [-p <v>]... [-o <out>]
                subscriptions-detach <subscription> [-p <v>]... [-o <out>]
                subscriptions-get <subscription> [-p <v>]... [-o <out>]
                subscriptions-get-iam-policy <resource> [-p <v>]... [-o <out>]
                subscriptions-list <project> [-p <v>]... [-o <out>]
                subscriptions-modify-ack-deadline <subscription> (-r <kv>)... [-p <v>]... [-o <out>]
                subscriptions-modify-push-config <subscription> (-r <kv>)... [-p <v>]... [-o <out>]
                subscriptions-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                subscriptions-pull <subscription> (-r <kv>)... [-p <v>]... [-o <out>]
                subscriptions-seek <subscription> (-r <kv>)... [-p <v>]... [-o <out>]
                subscriptions-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                subscriptions-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                topics-create <name> (-r <kv>)... [-p <v>]... [-o <out>]
                topics-delete <topic> [-p <v>]... [-o <out>]
                topics-get <topic> [-p <v>]... [-o <out>]
                topics-get-iam-policy <resource> [-p <v>]... [-o <out>]
                topics-list <project> [-p <v>]... [-o <out>]
                topics-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                topics-publish <topic> (-r <kv>)... [-p <v>]... [-o <out>]
                topics-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                topics-snapshots-list <topic> [-p <v>]... [-o <out>]
                topics-subscriptions-list <topic> [-p <v>]... [-o <out>]
                topics-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
  pubsub1 --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 文件中，文件名以 pubsub1- 前缀开头。您可以使用 --config-dir 标志在每个调用上更改用于存储配置的目录。

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

身份验证

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

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

首次使用作用域时，会请求用户授权。按照CLI给出的指示进行授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

您可以考虑将标准错误重定向到文件以便于使用，例如：pubsub1 --debug <资源> <方法> [选项] 2>debug.txt。