使用 versionhistory1 命令行界面（CLI），您可以在终端中轻松使用 Google 版本历史服务的大多数功能。

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

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

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

安装和源代码

使用 cargo 安装命令行界面：

cargo install google-versionhistory1-cli

在 GitHub 上查找源代码。

用法

此文档是根据 版本历史 API 在 20240303 修订版中生成的。CLI 的版本为 5.0.4。

versionhistory1 [options]
        platforms
                channels-list <parent> [-p <v>]... [-o <out>]
                channels-versions-list <parent> [-p <v>]... [-o <out>]
                channels-versions-releases-list <parent> [-p <v>]... [-o <out>]
                list <parent> [-p <v>]... [-o <out>]
  versionhistory1 --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 文件中，文件名以 versionhistory1- 开头。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

有关各种类型持久数据的更多信息，请参阅以下段落。

身份验证

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

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

第一次使用范围时，用户会被要求授权。按照 CLI 的说明授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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