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

5.0.4+20200628 2024年3月5日
3.1.0+20200628 2022年4月26日
3.0.0+20200628 2022年3月8日
2.0.4+20200628 2021年4月14日
0.3.6+20160805 2016年9月11日

#105 in #命令行界面

Download history 14/week @ 2024-03-10 1/week @ 2024-03-17 178/week @ 2024-03-31 2/week @ 2024-04-07 1/week @ 2024-05-19

每月下载 479

MIT 许可证

105KB
1.5K SLoC

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

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

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

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

安装和源代码

使用 cargo 安装命令行界面

cargo install google-appsactivity1-cli

github 上找到源代码。

用法

此文档是根据 appsactivity API 的 20200628 版本生成的。CLI 的版本为 5.0.4

appsactivity1 [options]
        activities
                list [-p <v>]... [-o <out>]
  appsactivity1 --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 文件中,文件以 appsactivity1- 为前缀。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

第一次使用范围时,系统会要求用户授权。遵循 CLI 提供的说明进行授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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

依赖项

~20–32MB
~582K SLoC