chromeuxreport1 命令行接口（CLI）允许您从终端舒适地使用Google Chrome UX Report服务的几乎所有功能。

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

如果请求数据结构，则这些数据结构将以漂亮的打印JSON格式返回，可作为其他工具的输入。

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

安装和源代码

使用cargo安装命令行接口：

cargo install google-chromeuxreport1-cli

在github上找到源代码。

用法

本文档是根据修订版20240228的Chrome UX Report API生成的。CLI版本为5.0.4。

chromeuxreport1 [options]
        records
                query-history-record (-r <kv>)... [-p <v>]... [-o <out>]
                query-record (-r <kv>)... [-p <v>]... [-o <out>]
  chromeuxreport1 --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文件中，文件以chromeuxreport1-为前缀。您可以使用--config-dir标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

首次使用范围时，用户会被要求授权。按照CLI提供的指示授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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