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

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

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

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

安装和源代码

使用cargo安装命令行界面

cargo install google-cloudshell1-cli

在GitHub上查找源代码。

使用方法

本文档是从修订版20240212的Cloud Shell API生成的。CLI版本为5.0.4。

cloudshell1 [options]
        operations
                cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                delete <name> [-p <v>]... [-o <out>]
                get <name> [-p <v>]... [-o <out>]
                list <name> [-p <v>]... [-o <out>]
        users
                environments-add-public-key <environment> (-r <kv>)... [-p <v>]... [-o <out>]
                environments-authorize <name> (-r <kv>)... [-p <v>]... [-o <out>]
                environments-get <name> [-p <v>]... [-o <out>]
                environments-remove-public-key <environment> (-r <kv>)... [-p <v>]... [-o <out>]
                environments-start <name> (-r <kv>)... [-p <v>]... [-o <out>]
  cloudshell1 --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文件中，文件名以cloudshell1-开头。您可以使用--config-dir标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

当作用域首次使用时，会提示用户授权。按照 CLI 的说明授权或拒绝。

如果作用域已被用户认证，相应的信息将以 JSON 格式存储在配置目录中，例如 ~/.google-service-cli/cloudshell1-token-<scope-hash>.json。无需手动管理这些令牌。

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

应用程序密钥

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

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

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

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

调试

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

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

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