homegraph1 命令行界面（CLI）允许您从终端舒适地使用 Google Home Graph Service 服务的几乎所有功能。

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

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

有关 Home Graph Service API 的其他信息，请参阅 官方文档站点。

安装和源代码

使用 cargo 安装命令行界面：

cargo install google-homegraph1-cli

在 GitHub 上查找源代码。

用法

此文档是从修订版 20200703 的 Home Graph Service API 生成的。CLI 版本为 1.0.14。

homegraph1 [options]
        agent-users
                delete <agent-user-id> [-p <v>]... [-o <out>]
        devices
                query (-r <kv>)... [-p <v>]... [-o <out>]
                report-state-and-notification (-r <kv>)... [-p <v>]... [-o <out>]
                request-sync (-r <kv>)... [-p <v>]... [-o <out>]
                sync (-r <kv>)... [-p <v>]... [-o <out>]
  homegraph1 --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 文件中，文件名以 homegraph1- 开头。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

第一次使用作用域时，系统会要求用户授权。遵循 CLI 提供的说明来授予权限或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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