该 secretmanager1-beta1 命令行界面（CLI）允许您从终端轻松使用Google Secret Manager服务的几乎所有功能。

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

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

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

安装和源代码

使用cargo安装命令行界面：

cargo install google-secretmanager1_beta1-cli

在GitHub上找到源代码。

用法

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

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

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

身份验证

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

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

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

如果用户已验证了范围，则相关信息将以 JSON 格式存储在配置目录中，例如 ~/.google-service-cli/secretmanager1-beta1-token-<scope-hash>.json。不需要手动管理这些令牌。

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

应用程序密钥

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

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

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

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

调试

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

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

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