#google #cli #google-api #pagespeed-online #command-line-interface

程序 google-pagespeedonline2-cli

与 pagespeedonline (协议 v2) 交互的完整库

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

5.0.4+20191206 2024年3月5日
3.1.0+20191206 2022年4月26日
3.0.0+20191206 2022年3月8日
2.0.4+20191206 2021年4月15日
0.3.6+20160811 2016年9月11日

#1 in #pagespeed-online

Download history 69/week @ 2024-03-07 5/week @ 2024-03-14 101/week @ 2024-03-28 74/week @ 2024-04-04

每月449 次下载

MIT 许可证

110KB
1.5K SLoC

pagespeedonline2 命令行界面 (CLI) 允许您在终端中舒适地使用 Google pagespeedonline 服务的大多数功能。

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

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

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

安装和源代码

使用 cargo 安装命令行界面:

cargo install google-pagespeedonline2-cli

GitHub 上找到源代码。

用法

此文档是从 pagespeedonline API(修订版 20191206)生成的。CLI 的版本为 5.0.4

pagespeedonline2 [options]
        pagespeedapi
                runpagespeed <url> [-p <v>]... [-o <out>]
  pagespeedonline2 --help

Configuration:
  --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 文件中,文件名以 pagespeedonline2- 前缀开头。您可以使用 --config-dir 标志根据调用更改用于存储配置的目录。

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

身份验证

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

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

首次使用范围时,系统会要求用户进行权限许可。遵循 CLI 提供的说明来授予权限或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

您可以考虑将标准错误重定向到文件以方便使用,例如pagespeedonline2 --debug <资源> <方法> [选项] 2>debug.txt

依赖项

~20–31MB
~582K SLoC