servicedirectory1 命令行接口（CLI）允许您从终端舒适地使用Google Service Directory服务的大多数功能。

默认情况下，所有输出都打印到标准输出，但可以通过设置标志将其直接定向到文件，而与shell的能力无关。错误将打印到标准错误，并导致程序退出码非零。

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

有关Service Directory API的所有其他信息，请参阅文档站点。

安装和源代码

使用cargo安装命令行界面

cargo install google-servicedirectory1-cli

在GitHub上找到源代码

用法

此文档是根据Service Directory API的修订版20240226生成的。CLI版本为5.0.4。

servicedirectory1 [options]
        projects
                locations-get <name> [-p <v>]... [-o <out>]
                locations-list <name> [-p <v>]... [-o <out>]
                locations-namespaces-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-namespaces-delete <name> [-p <v>]... [-o <out>]
                locations-namespaces-get <name> [-p <v>]... [-o <out>]
                locations-namespaces-get-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-namespaces-list <parent> [-p <v>]... [-o <out>]
                locations-namespaces-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-namespaces-services-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-namespaces-services-delete <name> [-p <v>]... [-o <out>]
                locations-namespaces-services-endpoints-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-namespaces-services-endpoints-delete <name> [-p <v>]... [-o <out>]
                locations-namespaces-services-endpoints-get <name> [-p <v>]... [-o <out>]
                locations-namespaces-services-endpoints-list <parent> [-p <v>]... [-o <out>]
                locations-namespaces-services-endpoints-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-namespaces-services-get <name> [-p <v>]... [-o <out>]
                locations-namespaces-services-get-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-namespaces-services-list <parent> [-p <v>]... [-o <out>]
                locations-namespaces-services-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-namespaces-services-resolve <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-namespaces-services-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-namespaces-services-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-namespaces-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-namespaces-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
  servicedirectory1 --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目录中存储所有持久数据，以servicedirectory1为前缀的JSON文件。您可以通过--config-dir标志在每次调用时更改用于存储配置的目录。

有关各种持久数据的更多信息，请参阅以下段落。

身份验证

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

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

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

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

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

应用程序密钥

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

为了使 CLI 更易于使用，而无需强制注册自己的应用程序，CLI 配置了默认的应用程序密钥。这也意味着全球范围内的频繁使用可能会耗尽每日配额。

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

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

调试

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

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

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