6个稳定版本

5.0.4+20240213 2024年3月5日
3.1.0+20220225 2022年4月26日
3.0.0+20220225 2022年3月8日
2.0.4+20210324 2021年4月15日

#292 in #command-line-interface

MIT 许可证

1MB
14K SLoC

artifactregistry1 命令行界面(CLI)允许您从终端舒适地使用Google Artifact Registry服务的大多数功能。

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

如果请求数据结构,则这些结构将作为美观打印的JSON返回,作为其他工具的输入很有用。

有关Artifact Registry API的所有其他信息,请参阅官方文档网站

安装和源代码

使用cargo安装命令行界面:

cargo install google-artifactregistry1-cli

github上找到源代码

用法

此文档是根据修订版 20240213 的Artifact Registry API生成的。CLI版本为 5.0.4

artifactregistry1 [options]
        projects
                get-project-settings <name> [-p <v>]... [-o <out>]
                locations-get <name> [-p <v>]... [-o <out>]
                locations-get-vpcsc-config <name> [-p <v>]... [-o <out>]
                locations-list <name> [-p <v>]... [-o <out>]
                locations-operations-get <name> [-p <v>]... [-o <out>]
                locations-repositories-apt-artifacts-import <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-repositories-apt-artifacts-upload <parent> (-r <kv>)... (-u simple -f <file> [-m <mime>]) [-p <v>]... [-o <out>]
                locations-repositories-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-repositories-delete <name> [-p <v>]... [-o <out>]
                locations-repositories-docker-images-get <name> [-p <v>]... [-o <out>]
                locations-repositories-docker-images-list <parent> [-p <v>]... [-o <out>]
                locations-repositories-files-get <name> [-p <v>]... [-o <out>]
                locations-repositories-files-list <parent> [-p <v>]... [-o <out>]
                locations-repositories-get <name> [-p <v>]... [-o <out>]
                locations-repositories-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-repositories-go-modules-upload <parent> (-r <kv>)... (-u simple -f <file> [-m <mime>]) [-p <v>]... [-o <out>]
                locations-repositories-googet-artifacts-import <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-repositories-googet-artifacts-upload <parent> (-r <kv>)... (-u simple -f <file> [-m <mime>]) [-p <v>]... [-o <out>]
                locations-repositories-kfp-artifacts-upload <parent> (-r <kv>)... (-u simple -f <file> [-m <mime>]) [-p <v>]... [-o <out>]
                locations-repositories-list <parent> [-p <v>]... [-o <out>]
                locations-repositories-maven-artifacts-get <name> [-p <v>]... [-o <out>]
                locations-repositories-maven-artifacts-list <parent> [-p <v>]... [-o <out>]
                locations-repositories-npm-packages-get <name> [-p <v>]... [-o <out>]
                locations-repositories-npm-packages-list <parent> [-p <v>]... [-o <out>]
                locations-repositories-packages-delete <name> [-p <v>]... [-o <out>]
                locations-repositories-packages-get <name> [-p <v>]... [-o <out>]
                locations-repositories-packages-list <parent> [-p <v>]... [-o <out>]
                locations-repositories-packages-tags-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-repositories-packages-tags-delete <name> [-p <v>]... [-o <out>]
                locations-repositories-packages-tags-get <name> [-p <v>]... [-o <out>]
                locations-repositories-packages-tags-list <parent> [-p <v>]... [-o <out>]
                locations-repositories-packages-tags-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-repositories-packages-versions-batch-delete <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-repositories-packages-versions-delete <name> [-p <v>]... [-o <out>]
                locations-repositories-packages-versions-get <name> [-p <v>]... [-o <out>]
                locations-repositories-packages-versions-list <parent> [-p <v>]... [-o <out>]
                locations-repositories-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-repositories-python-packages-get <name> [-p <v>]... [-o <out>]
                locations-repositories-python-packages-list <parent> [-p <v>]... [-o <out>]
                locations-repositories-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-repositories-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-repositories-yum-artifacts-import <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-repositories-yum-artifacts-upload <parent> (-r <kv>)... (-u simple -f <file> [-m <mime>]) [-p <v>]... [-o <out>]
                locations-update-vpcsc-config <name> (-r <kv>)... [-p <v>]... [-o <out>]
                update-project-settings <name> (-r <kv>)... [-p <v>]... [-o <out>]
  artifactregistry1 --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 文件中,文件名以 artifactregistry1- 开头。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

第一次使用作用域时,会要求用户进行授权。根据 CLI 提供的指示进行授权,或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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

依赖关系

~19–31MB
~580K SLoC