containeranalysis1命令行界面（CLI）允许您在终端中方便地使用Google Container Analysis服务的几乎所有功能。

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

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

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

安装和源代码

使用cargo通过以下方式安装命令行界面：

cargo install google-containeranalysis1-cli

在github上查找源代码。

用法

本文档是根据20240223版本的Container Analysis API生成的。CLI版本为5.0.4。

containeranalysis1 [options]
        projects
                notes-batch-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                notes-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                notes-delete <name> [-p <v>]... [-o <out>]
                notes-get <name> [-p <v>]... [-o <out>]
                notes-get-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                notes-list <parent> [-p <v>]... [-o <out>]
                notes-occurrences-list <name> [-p <v>]... [-o <out>]
                notes-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                notes-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                notes-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                occurrences-batch-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                occurrences-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                occurrences-delete <name> [-p <v>]... [-o <out>]
                occurrences-get <name> [-p <v>]... [-o <out>]
                occurrences-get-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                occurrences-get-notes <name> [-p <v>]... [-o <out>]
                occurrences-get-vulnerability-summary <parent> [-p <v>]... [-o <out>]
                occurrences-list <parent> [-p <v>]... [-o <out>]
                occurrences-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                occurrences-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                occurrences-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                resources-export-sbom <name> (-r <kv>)... [-p <v>]... [-o <out>]
  containeranalysis1 --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文件中，文件名以containeranalysis1-开头。您可以使用--config-dir标志在每次调用时更改用于存储配置的目录。

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

身份验证

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

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

首次使用范围时，会要求用户授权。按照 CLI 提供的说明授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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