#google #cli #google-api #命令行界面 #groupsmigration

应用 google-groupsmigration1-cli

用于与 Groups 迁移(协议 v1)交互的完整库

20 个稳定版本 (4 个主要版本)

5.0.4+20240222 2024 年 3 月 5 日
3.1.0+20220226 2022 年 4 月 26 日
3.0.0+20220226 2022 年 3 月 8 日
2.0.4+20210318 2021 年 4 月 15 日
0.3.6+20140416 2016 年 9 月 11 日

#61#命令行界面

Download history • Rust 包仓库 148/week @ 2024-04-02 • Rust 包仓库 1/week @ 2024-05-21 • Rust 包仓库

430 每月下载次数

MIT 许可证

93KB
1.5K SLoC

groupsmigration1 命令行界面(CLI)允许您从终端舒适地使用 Google Groups 迁移服务的几乎所有功能。

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

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

有关 Groups 迁移 API 的其他信息,请参阅官方文档站点

安装和源代码

使用 cargo 安装命令行界面

cargo install google-groupsmigration1-cli

GitHub上查找源代码。

用法

此文档是从 Groups 迁移 API(修订版 20240222)生成的。CLI 版本为 5.0.4

groupsmigration1 [options]
        archive
                insert <group-id> (-u simple -f <file> [-m <mime>]) [-p <v>]... [-o <out>]
  groupsmigration1 --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 目录中,以 groupsmigration1- 为前缀的 JSON 文件中。您可以使用 --config-dir 标志在每次调用中更改用于存储配置的目录。

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

身份验证

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

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

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

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

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

应用程序密钥

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

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

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

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

调试

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

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

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

依赖项

~20–31MB
~583K SLoC