11个稳定版本 (3个主要版本)

5.0.4+20240302 2024年3月5日
3.1.0+20220301 2022年4月26日
3.0.0+20220301 2022年3月8日
2.0.4+20210326 2021年4月15日
1.0.10+20190702 2019年7月6日

#2707 in Web编程

Download history 22/week @ 2024-03-08 3/week @ 2024-03-15 80/week @ 2024-03-29 17/week @ 2024-04-05

每月224次下载

MIT 许可证

140KB
2K SLoC

driveactivity2命令行界面(CLI)允许您在终端中方便地使用Google Drive Activity服务的几乎所有功能。

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

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

有关Drive Activity API的更多信息,请参阅官方文档网站

安装和源代码

使用cargo安装命令行界面:

cargo install google-driveactivity2-cli

github上找到源代码。

用法

本文档是根据修订版20240302的Drive Activity API生成的。CLI版本为5.0.4

driveactivity2 [options]
        activity
                query (-r <kv>)... [-p <v>]... [-o <out>]
  driveactivity2 --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目录中存储所有持久数据,这些文件以driveactivity2-为前缀的JSON文件开头。您可以使用--config-dir标志在每次调用中更改用于存储配置的目录。

有关各种持久数据的更多信息,请参阅以下段落。

身份验证

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

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

第一次使用作用域时,会要求用户进行授权。按照 CLI 提供的说明授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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

依赖项

~20–32MB
~581K SLoC