pagespeedonline5命令行界面（CLI）允许您从终端舒适地使用Google Pagespeed Insights服务的多数功能。

默认情况下，所有输出都打印到标准输出，但可以设置标志将其重定向到文件，而不依赖于shell的功能。错误将打印到标准错误，并导致程序退出代码不为零。

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

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

安装和源代码

使用cargo安装命令行界面：

cargo install google-pagespeedonline5-cli

在github上找到源代码。

用法

此文档是从修订版20240229的Pagespeed Insights API生成的。CLI版本为5.0.4。

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

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

身份验证

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

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

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

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

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

应用程序密钥

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

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

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

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

调试

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

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

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