clouddeploy1 命令行界面（CLI）允许您从终端舒适地使用Google Cloud Deploy服务的多数功能。

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

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

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

安装和源代码

使用cargo安装命令行界面：

cargo install google-clouddeploy1-cli

在github上找到源代码。

使用方法

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

clouddeploy1 [options]
        projects
                locations-custom-target-types-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-custom-target-types-delete <name> [-p <v>]... [-o <out>]
                locations-custom-target-types-get <name> [-p <v>]... [-o <out>]
                locations-custom-target-types-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-custom-target-types-list <parent> [-p <v>]... [-o <out>]
                locations-custom-target-types-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-custom-target-types-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-delivery-pipelines-automation-runs-cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-delivery-pipelines-automation-runs-get <name> [-p <v>]... [-o <out>]
                locations-delivery-pipelines-automation-runs-list <parent> [-p <v>]... [-o <out>]
                locations-delivery-pipelines-automations-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-delivery-pipelines-automations-delete <name> [-p <v>]... [-o <out>]
                locations-delivery-pipelines-automations-get <name> [-p <v>]... [-o <out>]
                locations-delivery-pipelines-automations-list <parent> [-p <v>]... [-o <out>]
                locations-delivery-pipelines-automations-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-delivery-pipelines-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-delivery-pipelines-delete <name> [-p <v>]... [-o <out>]
                locations-delivery-pipelines-get <name> [-p <v>]... [-o <out>]
                locations-delivery-pipelines-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-delivery-pipelines-list <parent> [-p <v>]... [-o <out>]
                locations-delivery-pipelines-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-delivery-pipelines-releases-abandon <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-delivery-pipelines-releases-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-delivery-pipelines-releases-get <name> [-p <v>]... [-o <out>]
                locations-delivery-pipelines-releases-list <parent> [-p <v>]... [-o <out>]
                locations-delivery-pipelines-releases-rollouts-advance <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-delivery-pipelines-releases-rollouts-approve <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-delivery-pipelines-releases-rollouts-cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-delivery-pipelines-releases-rollouts-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-delivery-pipelines-releases-rollouts-get <name> [-p <v>]... [-o <out>]
                locations-delivery-pipelines-releases-rollouts-ignore-job <rollout> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-delivery-pipelines-releases-rollouts-job-runs-get <name> [-p <v>]... [-o <out>]
                locations-delivery-pipelines-releases-rollouts-job-runs-list <parent> [-p <v>]... [-o <out>]
                locations-delivery-pipelines-releases-rollouts-job-runs-terminate <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-delivery-pipelines-releases-rollouts-list <parent> [-p <v>]... [-o <out>]
                locations-delivery-pipelines-releases-rollouts-retry-job <rollout> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-delivery-pipelines-rollback-target <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-delivery-pipelines-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-delivery-pipelines-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-get <name> [-p <v>]... [-o <out>]
                locations-get-config <name> [-p <v>]... [-o <out>]
                locations-list <name> [-p <v>]... [-o <out>]
                locations-operations-cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-operations-delete <name> [-p <v>]... [-o <out>]
                locations-operations-get <name> [-p <v>]... [-o <out>]
                locations-operations-list <name> [-p <v>]... [-o <out>]
                locations-targets-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-targets-delete <name> [-p <v>]... [-o <out>]
                locations-targets-get <name> [-p <v>]... [-o <out>]
                locations-targets-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-targets-list <parent> [-p <v>]... [-o <out>]
                locations-targets-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-targets-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-targets-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
  clouddeploy1 --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 文件中，文件以 clouddeploy1- 前缀开头。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

第一次使用作用域时，用户会被要求授权。按照CLI给出的说明授权权限，或者拒绝。

如果用户已通过作用域进行身份验证，相关信息将作为 JSON 存储在配置目录中，例如 ~/.google-service-cli/clouddeploy1-token-<scope-hash>.json。无需手动管理这些令牌。

要撤销已授予的身份验证，请参阅官方文档。

应用程序密钥

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

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

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

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

调试

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

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

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