该cloudbuild1命令行界面（CLI）允许您在终端舒适地使用Google Cloud Build服务的几乎所有功能。

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

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

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

安装和源代码

使用cargo安装命令行界面

cargo install google-cloudbuild1-cli

在GitHub上找到源代码。

用法

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

cloudbuild1 [options]
        github-dot-com-webhook
                receive (-r <kv>)... [-p <v>]... [-o <out>]
        locations
                regional-webhook <location> (-r <kv>)... [-p <v>]... [-o <out>]
        methods
                webhook (-r <kv>)... [-p <v>]... [-o <out>]
        operations
                cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                get <name> [-p <v>]... [-o <out>]
        projects
                builds-approve <name> (-r <kv>)... [-p <v>]... [-o <out>]
                builds-cancel <project-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                builds-create <project-id> (-r <kv>)... [-p <v>]... [-o <out>]
                builds-get <project-id> <id> [-p <v>]... [-o <out>]
                builds-list <project-id> [-p <v>]... [-o <out>]
                builds-retry <project-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                github-enterprise-configs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                github-enterprise-configs-delete <name> [-p <v>]... [-o <out>]
                github-enterprise-configs-get <name> [-p <v>]... [-o <out>]
                github-enterprise-configs-list <parent> [-p <v>]... [-o <out>]
                github-enterprise-configs-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-bitbucket-server-configs-connected-repositories-batch-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-bitbucket-server-configs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-bitbucket-server-configs-delete <name> [-p <v>]... [-o <out>]
                locations-bitbucket-server-configs-get <name> [-p <v>]... [-o <out>]
                locations-bitbucket-server-configs-list <parent> [-p <v>]... [-o <out>]
                locations-bitbucket-server-configs-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-bitbucket-server-configs-remove-bitbucket-server-connected-repository <config> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-bitbucket-server-configs-repos-list <parent> [-p <v>]... [-o <out>]
                locations-builds-approve <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-builds-cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-builds-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-builds-get <name> [-p <v>]... [-o <out>]
                locations-builds-list <parent> [-p <v>]... [-o <out>]
                locations-builds-retry <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-get-default-service-account <name> [-p <v>]... [-o <out>]
                locations-git-lab-configs-connected-repositories-batch-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-git-lab-configs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-git-lab-configs-delete <name> [-p <v>]... [-o <out>]
                locations-git-lab-configs-get <name> [-p <v>]... [-o <out>]
                locations-git-lab-configs-list <parent> [-p <v>]... [-o <out>]
                locations-git-lab-configs-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-git-lab-configs-remove-git-lab-connected-repository <config> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-git-lab-configs-repos-list <parent> [-p <v>]... [-o <out>]
                locations-github-enterprise-configs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-github-enterprise-configs-delete <name> [-p <v>]... [-o <out>]
                locations-github-enterprise-configs-get <name> [-p <v>]... [-o <out>]
                locations-github-enterprise-configs-list <parent> [-p <v>]... [-o <out>]
                locations-github-enterprise-configs-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-operations-cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-operations-get <name> [-p <v>]... [-o <out>]
                locations-triggers-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-triggers-delete <name> [-p <v>]... [-o <out>]
                locations-triggers-get <name> [-p <v>]... [-o <out>]
                locations-triggers-list <parent> [-p <v>]... [-o <out>]
                locations-triggers-patch <resource-name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-triggers-run <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-triggers-webhook <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-worker-pools-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-worker-pools-delete <name> [-p <v>]... [-o <out>]
                locations-worker-pools-get <name> [-p <v>]... [-o <out>]
                locations-worker-pools-list <parent> [-p <v>]... [-o <out>]
                locations-worker-pools-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                triggers-create <project-id> (-r <kv>)... [-p <v>]... [-o <out>]
                triggers-delete <project-id> <trigger-id> [-p <v>]... [-o <out>]
                triggers-get <project-id> <trigger-id> [-p <v>]... [-o <out>]
                triggers-list <project-id> [-p <v>]... [-o <out>]
                triggers-patch <project-id> <trigger-id> (-r <kv>)... [-p <v>]... [-o <out>]
                triggers-run <project-id> <trigger-id> (-r <kv>)... [-p <v>]... [-o <out>]
                triggers-webhook <project-id> <trigger> (-r <kv>)... [-p <v>]... [-o <out>]
  cloudbuild1 --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文件中存储所有持久数据，文件名以cloudbuild1-开头。您可以使用--config-dir标志在每次调用中更改用于存储配置的目录。

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

身份验证

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

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

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

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

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

应用程序密钥

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

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

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

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

调试

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

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

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