tpu1-alpha1 命令行界面 (CLI) 允许您从终端舒适地使用 Google TPU 服务的几乎所有功能。

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

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

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

安装和源代码

使用 cargo 安装命令行界面：

cargo install google-tpu1_alpha1-cli

在 GitHub 上找到源代码。

用法

本文档是从修订版 20240222 的 TPU API 生成的。CLI 的版本为 5.0.4。

tpu1-alpha1 [options]
        projects
                locations-accelerator-types-get <name> [-p <v>]... [-o <out>]
                locations-accelerator-types-list <parent> [-p <v>]... [-o <out>]
                locations-get <name> [-p <v>]... [-o <out>]
                locations-list <name> [-p <v>]... [-o <out>]
                locations-nodes-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-nodes-delete <name> [-p <v>]... [-o <out>]
                locations-nodes-get <name> [-p <v>]... [-o <out>]
                locations-nodes-list <parent> [-p <v>]... [-o <out>]
                locations-nodes-reimage <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-nodes-start <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-nodes-stop <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-operations-cancel <name> [-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-tensorflow-versions-get <name> [-p <v>]... [-o <out>]
                locations-tensorflow-versions-list <parent> [-p <v>]... [-o <out>]
  tpu1-alpha1 --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 文件中，文件名以 tpu1-alpha1- 开头。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

首次使用范围时，用户将被要求授权。根据 CLI 提供的说明授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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