clouddebugger2 命令行界面（CLI）允许您在终端中舒适地使用Google Cloud Debugger服务的多数功能。

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

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

有关Cloud Debugger API的更多信息，请参阅官方文档网站。

安装和源代码

使用cargo安装命令行界面：

cargo install google-clouddebugger2-cli

在github上找到源代码。

用法

此文档是根据修订版20230113的Cloud Debugger API生成的。CLI版本为5.0.4。

clouddebugger2 [options]
        controller
                debuggees-breakpoints-list <debuggee-id> [-p <v>]... [-o <out>]
                debuggees-breakpoints-update <debuggee-id> <id> (-r <kv>)... [-p <v>]... [-o <out>]
                debuggees-register (-r <kv>)... [-p <v>]... [-o <out>]
        debugger
                debuggees-breakpoints-delete <debuggee-id> <breakpoint-id> [-p <v>]... [-o <out>]
                debuggees-breakpoints-get <debuggee-id> <breakpoint-id> [-p <v>]... [-o <out>]
                debuggees-breakpoints-list <debuggee-id> [-p <v>]... [-o <out>]
                debuggees-breakpoints-set <debuggee-id> (-r <kv>)... [-p <v>]... [-o <out>]
                debuggees-list [-p <v>]... [-o <out>]
  clouddebugger2 --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文件中，以clouddebugger2为前缀。您可以使用--config-dir标志在每次调用时更改用于存储配置的目录。

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

身份验证

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

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

第一次使用作用域时，系统会提示用户授权。遵循CLI提供的说明授予权限或拒绝权限。

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

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

应用程序密钥

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

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

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

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

调试

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

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

您可以考虑将标准错误重定向到文件，以便于使用，例如：clouddebugger2 --debug <资源> <方法> [选项] 2>debug.txt。