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

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

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

有关存储 API 的其他所有信息，请参阅官方文档网站。

安装和源代码

使用 cargo 安装命令行界面

cargo install google-storage1-cli

在 github 上查找源代码。

用法

本文档是从 存储 API 修订版 20220228 生成的。CLI 版本为 3.1.0。

storage1 [options]
        bucket-access-controls
                delete <bucket> <entity> [-p <v>]...
                get <bucket> <entity> [-p <v>]... [-o <out>]
                insert <bucket> (-r <kv>)... [-p <v>]... [-o <out>]
                list <bucket> [-p <v>]... [-o <out>]
                patch <bucket> <entity> (-r <kv>)... [-p <v>]... [-o <out>]
                update <bucket> <entity> (-r <kv>)... [-p <v>]... [-o <out>]
        buckets
                delete <bucket> [-p <v>]...
                get <bucket> [-p <v>]... [-o <out>]
                get-iam-policy <bucket> [-p <v>]... [-o <out>]
                insert <project> (-r <kv>)... [-p <v>]... [-o <out>]
                list <project> [-p <v>]... [-o <out>]
                lock-retention-policy <bucket> <if-metageneration-match> [-p <v>]... [-o <out>]
                patch <bucket> (-r <kv>)... [-p <v>]... [-o <out>]
                set-iam-policy <bucket> (-r <kv>)... [-p <v>]... [-o <out>]
                test-iam-permissions <bucket> <permissions>... [-p <v>]... [-o <out>]
                update <bucket> (-r <kv>)... [-p <v>]... [-o <out>]
        channels
                stop (-r <kv>)... [-p <v>]...
        default-object-access-controls
                delete <bucket> <entity> [-p <v>]...
                get <bucket> <entity> [-p <v>]... [-o <out>]
                insert <bucket> (-r <kv>)... [-p <v>]... [-o <out>]
                list <bucket> [-p <v>]... [-o <out>]
                patch <bucket> <entity> (-r <kv>)... [-p <v>]... [-o <out>]
                update <bucket> <entity> (-r <kv>)... [-p <v>]... [-o <out>]
        notifications
                delete <bucket> <notification> [-p <v>]...
                get <bucket> <notification> [-p <v>]... [-o <out>]
                insert <bucket> (-r <kv>)... [-p <v>]... [-o <out>]
                list <bucket> [-p <v>]... [-o <out>]
        object-access-controls
                delete <bucket> <object> <entity> [-p <v>]...
                get <bucket> <object> <entity> [-p <v>]... [-o <out>]
                insert <bucket> <object> (-r <kv>)... [-p <v>]... [-o <out>]
                list <bucket> <object> [-p <v>]... [-o <out>]
                patch <bucket> <object> <entity> (-r <kv>)... [-p <v>]... [-o <out>]
                update <bucket> <object> <entity> (-r <kv>)... [-p <v>]... [-o <out>]
        objects
                compose <destination-bucket> <destination-object> (-r <kv>)... [-p <v>]... [-o <out>]
                copy <source-bucket> <source-object> <destination-bucket> <destination-object> (-r <kv>)... [-p <v>]... [-o <out>]
                delete <bucket> <object> [-p <v>]...
                get <bucket> <object> [-p <v>]... [-o <out>]
                get-iam-policy <bucket> <object> [-p <v>]... [-o <out>]
                insert <bucket> (-r <kv>)... (-u simple -f <file> [-m <mime>]) [-p <v>]... [-o <out>]
                list <bucket> [-p <v>]... [-o <out>]
                patch <bucket> <object> (-r <kv>)... [-p <v>]... [-o <out>]
                rewrite <source-bucket> <source-object> <destination-bucket> <destination-object> (-r <kv>)... [-p <v>]... [-o <out>]
                set-iam-policy <bucket> <object> (-r <kv>)... [-p <v>]... [-o <out>]
                test-iam-permissions <bucket> <object> <permissions>... [-p <v>]... [-o <out>]
                update <bucket> <object> (-r <kv>)... [-p <v>]... [-o <out>]
                watch-all <bucket> (-r <kv>)... [-p <v>]... [-o <out>]
        projects
                hmac-keys-create <project-id> <service-account-email> [-p <v>]... [-o <out>]
                hmac-keys-delete <project-id> <access-id> [-p <v>]...
                hmac-keys-get <project-id> <access-id> [-p <v>]... [-o <out>]
                hmac-keys-list <project-id> [-p <v>]... [-o <out>]
                hmac-keys-update <project-id> <access-id> (-r <kv>)... [-p <v>]... [-o <out>]
                service-account-get <project-id> [-p <v>]... [-o <out>]
  storage1 --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 文件中，文件前缀为 storage1-。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

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

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

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

应用程序密钥

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

为了使 CLI 的使用更加方便，无需强迫用户注册自己的应用程序，CLI 内置了一个默认的应用程序密钥，并相应地进行配置。这也意味着全球范围内的重度使用可能会耗尽每日配额。

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

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

调试

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

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

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