kgsearch1 命令行界面（CLI）允许您在终端中舒适地使用Google kgsearch服务的几乎所有功能。

默认情况下，所有输出都打印到标准输出，但可以通过标志将其直接定向到文件，而无需考虑shell的功能。错误将打印到标准错误，并导致程序的退出代码不为零。

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

关于kgsearch API的所有其他信息都可以在官方文档站点找到。

安装和源代码

使用cargo安装命令行界面：

cargo install google-kgsearch1-cli

在GitHub上查找源代码。

用法

本文档是从kgsearch API的修订版20170109生成的。CLI版本为1.0.4。

kgsearch1 [options]
        entities
                search [-p <v>]... [-o <out>]
  kgsearch1 --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]
  --debug
            Output all server communication to standard error. `tx` and `rx` are placed
            into the same stream.
  --debug-auth
            Output all communication related to authentication to standard error. `tx`
            and `rx` are placed into the same stream.

配置

程序将所有持久数据存储在~/.google-service-cli目录中的JSON文件中，文件以kgsearch1-为前缀。您可以通过--config-dir标志在每次调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

第一次使用范围时，会要求用户授权。按照 CLI 指示授予权限或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

--debug 标志将打印所有客户端-服务器通信到标准错误，而 --debug-auth 标志将导致所有与认证相关的通信输出到标准错误。如果设置了 --debug 标志，则错误结果将被调试打印，可能提供更多有关当前问题的信息。