该remotebuildexecution2命令行界面（CLI）允许您在终端舒适地使用Google远程构建执行服务的大多数功能。

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

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

有关远程构建执行API的所有其他信息，请参阅官方文档站点。

安装和源代码

使用cargo安装命令行界面：

cargo install google-remotebuildexecution2-cli

在GitHub上找到源代码。

用法

本文档是从修订版20210329的远程构建执行API生成的。CLI版本为3.0.0。

remotebuildexecution2 [options]
        action-results
                get <instance-name> <hash> <size-bytes> [-p <v>]... [-o <out>]
                update <instance-name> <hash> <size-bytes> (-r <kv>)... [-p <v>]... [-o <out>]
        actions
                execute <instance-name> (-r <kv>)... [-p <v>]... [-o <out>]
        blobs
                batch-read <instance-name> (-r <kv>)... [-p <v>]... [-o <out>]
                batch-update <instance-name> (-r <kv>)... [-p <v>]... [-o <out>]
                find-missing <instance-name> (-r <kv>)... [-p <v>]... [-o <out>]
                get-tree <instance-name> <hash> <size-bytes> [-p <v>]... [-o <out>]
        methods
                get-capabilities <instance-name> [-p <v>]... [-o <out>]
        operations
                wait-execution <name> (-r <kv>)... [-p <v>]... [-o <out>]
  remotebuildexecution2 --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文件中，文件名以remotebuildexecution2-开头。您可以使用--config-dir标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

首次使用作用域时，系统会要求用户授权。根据CLI的指示授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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