该customsearch1命令行界面（CLI）允许您在终端中舒适地使用Google CustomSearch API服务的大部分功能。

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

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

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

安装和源代码

使用cargo安装命令行界面

cargo install google-customsearch1-cli

在GitHub上找到源代码。

用法

本文档是根据修订版20240303的CustomSearch API API生成的。CLI版本为5.0.4。

customsearch1 [options]
        cse
                list [-p <v>]... [-o <out>]
                siterestrict-list [-p <v>]... [-o <out>]
  customsearch1 --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文件中，这些文件以customsearch1-为前缀。您可以使用--config-dir标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

首次使用作用域时，系统会要求用户授权。遵循CLI给出的说明授予权限或拒绝。

如果用户验证了作用域，相关数据将以JSON格式存储在配置目录中，例如~/.google-service-cli/customsearch1-token-<scope-hash>.json。无需手动管理这些令牌。

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

应用程序密钥

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

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

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

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

调试

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

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

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