11个稳定版本 (3个主要版本)

5.0.4+20240303 2024年3月5日
3.1.0+20220305 2022年4月26日
3.0.0+20220305 2022年3月8日
2.0.4+20210330 2021年4月15日
1.0.10+20190703 2019年7月6日

#2572 in 网络编程

MIT许可证

215KB
3K SLoC

factchecktools1-alpha1命令行界面(CLI)允许用户从终端舒适地使用Google事实核查工具(服务)的大多数功能。

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

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

关于事实核查工具API的其余信息可以在官方文档网站找到。

安装和源代码

使用cargo安装命令行界面

cargo install google-factchecktools1_alpha1-cli

GitHub上查找源代码

用法

此文档是从修订版20240303的事实核查工具API生成的。CLI版本为5.0.4

factchecktools1-alpha1 [options]
        claims
                search [-p <v>]... [-o <out>]
        pages
                create (-r <kv>)... [-p <v>]... [-o <out>]
                delete <name> [-p <v>]... [-o <out>]
                get <name> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                update <name> (-r <kv>)... [-p <v>]... [-o <out>]
  factchecktools1-alpha1 --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文件中,文件以factchecktools1-alpha1-开头。您可以通过在每次调用上设置--config-dir标志来更改用于存储配置的目录。

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

身份验证

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

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

首次使用范围时,会询问用户权限。按照CLI给出的说明授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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

依赖项

~20–31MB
~579K SLoC