resourcesettings1 命令行接口（CLI）允许您在终端舒适地使用Google资源设置服务的大多数功能。

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

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

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

安装和源代码

使用cargo安装命令行接口

cargo install google-resourcesettings1-cli

在github上查找源代码。

用法

本文档是根据资源设置 API在20230123版本中生成的。CLI的版本是5.0.3。

resourcesettings1 [options]
        folders
                settings-get <name> [-p <v>]... [-o <out>]
                settings-list <parent> [-p <v>]... [-o <out>]
                settings-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
        organizations
                settings-get <name> [-p <v>]... [-o <out>]
                settings-list <parent> [-p <v>]... [-o <out>]
                settings-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
        projects
                settings-get <name> [-p <v>]... [-o <out>]
                settings-list <parent> [-p <v>]... [-o <out>]
                settings-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
  resourcesettings1 --help

Configuration:
  [--scope <url>]...
            Specify the authentication a method should be executed in. Each scope
            requires the user to grant this application permission to use it.
            If unset, it defaults to the shortest scope url for a particular method.
  --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文件中，文件名以resourcesettings1-开头。您可以使用--config-dir标志在每次调用中更改用于存储配置的目录。

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

身份验证

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

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

第一次使用范围时，用户将被要求授权。按照 CLI 提供的说明授予权限，或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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