policyanalyzer1命令行界面（CLI）允许您在终端中方便地使用Google Policy Analyzer服务的多数功能。

默认情况下，所有输出都打印到标准输出，但可以使用标志将其直接导向文件，而不受shell功能的影响。错误将打印到标准错误，并使程序的退出代码为非零。

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

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

安装和源代码

使用cargo安装命令行界面：

cargo install google-policyanalyzer1-cli

在github上找到源代码。

用法

本文档是根据修订版20240303的Policy Analyzer API生成的。CLI版本为5.0.4。

policyanalyzer1 [options]
        projects
                locations-activity-types-activities-query <parent> [-p <v>]... [-o <out>]
  policyanalyzer1 --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文件中，文件名以policyanalyzer1-开头。您可以使用--config-dir标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

第一次使用作用域时，系统会要求用户授权。按照CLI的说明授予权限或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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