mirror1 命令行界面 (CLI) 允许您从终端方便地使用 Google镜像 服务的几乎所有功能。

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

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

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

安装和源代码

使用 cargo 安装命令行界面：

cargo install google-mirror1-cli

在GitHub上找到源代码。

用法

本文档是根据修订版 20190424 的 mirror API 生成的。CLI版本为 5.0.4。

mirror1 [options]
        accounts
                insert <user-token> <account-type> <account-name> (-r <kv>)... [-p <v>]... [-o <out>]
        contacts
                delete <id> [-p <v>]...
                get <id> [-p <v>]... [-o <out>]
                insert (-r <kv>)... [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                patch <id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <id> (-r <kv>)... [-p <v>]... [-o <out>]
        locations
                get <id> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
        settings
                get <id> [-p <v>]... [-o <out>]
        subscriptions
                delete <id> [-p <v>]...
                insert (-r <kv>)... [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                update <id> (-r <kv>)... [-p <v>]... [-o <out>]
        timeline
                attachments-delete <item-id> <attachment-id> [-p <v>]...
                attachments-get <item-id> <attachment-id> [-p <v>]... [-o <out>]
                attachments-insert <item-id> (-u simple -f <file> [-m <mime>]) [-p <v>]... [-o <out>]
                attachments-list <item-id> [-p <v>]... [-o <out>]
                delete <id> [-p <v>]...
                get <id> [-p <v>]... [-o <out>]
                insert (-r <kv>)... (-u simple -f <file> [-m <mime>]) [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                patch <id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <id> (-r <kv>)... (-u simple -f <file> [-m <mime>]) [-p <v>]... [-o <out>]
  mirror1 --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 文件中存储所有持久数据，文件以 mirror1- 前缀开头。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

第一次使用作用域时，系统会要求用户进行权限许可。根据CLI的指示授予权限或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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