该 notebooks1 命令行界面（CLI）允许您从终端舒适地使用 Google AI 平台笔记本服务的大部分功能。

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

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

有关 AI 平台笔记本 API 的其他所有信息，请参阅 官方文档站点。

安装和源代码

使用 cargo 安装命令行界面：

cargo install google-notebooks1-cli

在 github 上找到源代码。

用法

此文档是根据 AI 平台笔记本 API 在 20231227 修订版中生成的。CLI 版本为 5.0.4。

notebooks1 [options]
        projects
                locations-environments-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-environments-delete <name> [-p <v>]... [-o <out>]
                locations-environments-get <name> [-p <v>]... [-o <out>]
                locations-environments-list <parent> [-p <v>]... [-o <out>]
                locations-executions-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-executions-delete <name> [-p <v>]... [-o <out>]
                locations-executions-get <name> [-p <v>]... [-o <out>]
                locations-executions-list <parent> [-p <v>]... [-o <out>]
                locations-get <name> [-p <v>]... [-o <out>]
                locations-instances-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-delete <name> [-p <v>]... [-o <out>]
                locations-instances-diagnose <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-get <name> [-p <v>]... [-o <out>]
                locations-instances-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-instances-get-instance-health <name> [-p <v>]... [-o <out>]
                locations-instances-is-upgradeable <notebook-instance> [-p <v>]... [-o <out>]
                locations-instances-list <parent> [-p <v>]... [-o <out>]
                locations-instances-migrate <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-register <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-report <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-report-event <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-reset <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-rollback <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-set-accelerator <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-set-labels <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-set-machine-type <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-start <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-stop <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-update-config <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-update-metadata-items <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-update-shielded-instance-config <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-upgrade <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-upgrade-internal <name> (-r <kv>)... [-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-runtimes-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-runtimes-delete <name> [-p <v>]... [-o <out>]
                locations-runtimes-diagnose <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-runtimes-get <name> [-p <v>]... [-o <out>]
                locations-runtimes-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-runtimes-list <parent> [-p <v>]... [-o <out>]
                locations-runtimes-migrate <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-runtimes-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-runtimes-refresh-runtime-token-internal <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-runtimes-report-event <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-runtimes-reset <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-runtimes-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-runtimes-start <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-runtimes-stop <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-runtimes-switch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-runtimes-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-runtimes-upgrade <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-schedules-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-schedules-delete <name> [-p <v>]... [-o <out>]
                locations-schedules-get <name> [-p <v>]... [-o <out>]
                locations-schedules-list <parent> [-p <v>]... [-o <out>]
                locations-schedules-trigger <name> (-r <kv>)... [-p <v>]... [-o <out>]
  notebooks1 --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 目录中存储所有持久数据，目录以 notebooks1- 开头的 JSON 文件。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

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

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

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

应用程序密钥

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

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

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

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

调试

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

带有--debug标志将错误以Debug表示形式打印到标准错误。

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