该apikeys2命令行界面（CLI）允许您从终端舒适地使用Google Api Keys Service服务的大多数功能。

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

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

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

安装和源代码

使用cargo安装命令行界面

cargo install google-apikeys2-cli

在GitHub上找到源代码。

使用方法

此文档是从修订版20240303的Api Keys Service API生成的。CLI的版本是5.0.4。

apikeys2 [options]
        keys
                lookup-key [-p <v>]... [-o <out>]
        operations
                get <name> [-p <v>]... [-o <out>]
        projects
                locations-keys-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-keys-delete <name> [-p <v>]... [-o <out>]
                locations-keys-get <name> [-p <v>]... [-o <out>]
                locations-keys-get-key-string <name> [-p <v>]... [-o <out>]
                locations-keys-list <parent> [-p <v>]... [-o <out>]
                locations-keys-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-keys-undelete <name> (-r <kv>)... [-p <v>]... [-o <out>]
  apikeys2 --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目录中存储所有持久数据，该目录以apikeys2-为前缀的JSON文件中。您可以使用--config-dir标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

首次使用范围时，系统会要求用户授权。按照CLI给出的说明授权权限或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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