该 secretmanager1 命令行界面 (CLI) 允许您从终端舒适地使用 Google Secret Manager 服务的几乎所有功能。

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

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

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

安装和源代码

使用 cargo 安装命令行界面

cargo install google-secretmanager1-cli

在 GitHub 上查找源代码。

用法

本文档是根据修订版 20240223 的 Secret Manager API 生成的。CLI 版本为 5.0.4。

secretmanager1 [options]
        projects
                locations-get <name> [-p <v>]... [-o <out>]
                locations-list <name> [-p <v>]... [-o <out>]
                locations-secrets-add-version <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-secrets-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-secrets-delete <name> [-p <v>]... [-o <out>]
                locations-secrets-get <name> [-p <v>]... [-o <out>]
                locations-secrets-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-secrets-list <parent> [-p <v>]... [-o <out>]
                locations-secrets-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-secrets-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-secrets-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-secrets-versions-access <name> [-p <v>]... [-o <out>]
                locations-secrets-versions-destroy <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-secrets-versions-disable <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-secrets-versions-enable <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-secrets-versions-get <name> [-p <v>]... [-o <out>]
                locations-secrets-versions-list <parent> [-p <v>]... [-o <out>]
                secrets-add-version <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                secrets-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                secrets-delete <name> [-p <v>]... [-o <out>]
                secrets-get <name> [-p <v>]... [-o <out>]
                secrets-get-iam-policy <resource> [-p <v>]... [-o <out>]
                secrets-list <parent> [-p <v>]... [-o <out>]
                secrets-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                secrets-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                secrets-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                secrets-versions-access <name> [-p <v>]... [-o <out>]
                secrets-versions-destroy <name> (-r <kv>)... [-p <v>]... [-o <out>]
                secrets-versions-disable <name> (-r <kv>)... [-p <v>]... [-o <out>]
                secrets-versions-enable <name> (-r <kv>)... [-p <v>]... [-o <out>]
                secrets-versions-get <name> [-p <v>]... [-o <out>]
                secrets-versions-list <parent> [-p <v>]... [-o <out>]
  secretmanager1 --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 目录中，以 secretmanager1- 开头的 JSON 文件中。您可以使用 --config-dir 标志在每次调用时更改用于存储配置的目录。

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

身份验证

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

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

第一次使用范围时，用户会被要求授权。根据CLI的指示授权，或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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