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

默认情况下，所有输出都打印到标准输出，但可以使用标志将其定向到独立于您的 shell 功能的文件。错误将打印到标准错误，并导致程序的退出码不为零。

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

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

安装和源代码

使用 cargo 安装命令行界面

cargo install google-pagespeedonline4-cli

在 github 上找到源代码。

用法

此文档是根据 pagespeedonline API 修订版 20191206 生成的。CLI 的版本是 5.0.4。

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

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

身份验证

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

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

第一次使用范围时，系统会要求用户授权。根据CLI的指示授权或拒绝。

如果用户验证了范围，相关信息将作为JSON存储在配置目录中，例如：~/.google-service-cli/pagespeedonline4-token-<scope-hash>.json。无需手动管理这些令牌。

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

应用程序密钥

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

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

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

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

调试

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

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

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