该 webrisk1 命令行接口 (CLI) 允许您从终端轻松使用 Google Web Risk 服务的多数功能。

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

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

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

安装和源代码

使用 cargo 安装命令行界面：

cargo install google-webrisk1-cli

在 GitHub上找到源代码。

用法

本文档是从修订版 20220226 的 Web Risk API 生成的。CLI 版本为 3.1.0。

webrisk1 [options]
        hashes
                search [-p <v>]... [-o <out>]
        projects
                operations-cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                operations-delete <name> [-p <v>]... [-o <out>]
                operations-get <name> [-p <v>]... [-o <out>]
                operations-list <name> [-p <v>]... [-o <out>]
                submissions-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                uris-submit <parent> (-r <kv>)... [-p <v>]... [-o <out>]
        threat-lists
                compute-diff [-p <v>]... [-o <out>]
        uris
                search [-p <v>]... [-o <out>]
  webrisk1 --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 文件中，以 webrisk1- 为前缀。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

第一次使用作用域时，系统会要求用户授权。按照 CLI 提供的说明授权或拒绝授权。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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