该 ideahub1-beta 命令行界面（CLI）允许您从终端舒适地使用 Google Ideahub 服务的多数功能。

默认情况下，所有输出都打印到标准输出，但可以使用标志将其定向到与您的 shell 功能无关的文件。错误将打印到标准错误，并导致程序退出代码不为零。

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

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

安装和源代码

使用 cargo 安装命令行界面：

cargo install google-ideahub1_beta-cli

在 GitHub 上找到源代码。

用法

本文档是根据 Ideahub API 的 20220305 版本生成的。CLI 的版本为 5.0.4。

ideahub1-beta [options]
        platforms
                properties-idea-activities-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                properties-idea-states-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                properties-ideas-list <parent> [-p <v>]... [-o <out>]
                properties-locales-list <parent> [-p <v>]... [-o <out>]
                properties-topic-states-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
  ideahub1-beta --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 文件中，文件名以 ideahub1-beta- 开头。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

第一次使用作用域时，会提示用户请求权限。按照CLI给出的指示授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

使用--debug标志将错误以Debug表示形式输出到标准错误。

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