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

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

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

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

下载

您可以为以下平台下载预编译的 64 位二进制文件

• ubuntu
• osx

在 GitHub 上找到源代码。

用法

本文档是根据修订版 20160823 的 Civic Info API 生成的。CLI 版本为 1.0.0。

civicinfo2 [options]
        divisions
                search [-p <v>]... [-o <out>]
        elections
                election-query [-p <v>]... [-o <out>]
                voter-info-query <address> [-p <v>]... [-o <out>]
        representatives
                representative-info-by-address [-p <v>]... [-o <out>]
                representative-info-by-division <ocd-id> [-p <v>]... [-o <out>]
  civicinfo2 --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 文件中，文件名以 civicinfo2- 开头。您可以使用 --config-dir 标志在每个调用中更改用于存储配置的目录。

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

身份验证

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

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

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

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

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

应用程序密钥

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

为了使CLI的用法更加便捷，而无需强迫任何人注册自己的应用程序，CLI自带了一个默认的应用程序密钥，并据此进行配置。这也意味着全球范围内的频繁使用可能会耗尽每日配额。

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

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

调试

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

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