该 runtimeconfig1 命令行接口 (CLI) 允许您在终端中舒适地使用Google Cloud RuntimeConfig服务的多数功能。

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

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

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

安装和源代码

使用cargo安装命令行接口：

cargo install google-runtimeconfig1-cli

在GitHub上找到源代码。

用法

本文档是根据修订版 20240227 的 Cloud RuntimeConfig API生成的。CLI版本为 5.0.4。

runtimeconfig1 [options]
        operations
                cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                delete <name> [-p <v>]... [-o <out>]
                list <name> [-p <v>]... [-o <out>]
  runtimeconfig1 --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文件中，文件名以runtimeconfig1-开头。您可以使用--config-dir标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

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

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

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

应用程序密钥

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

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

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

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

调试

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

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

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