通过命令行界面（CLI）使用Google Vault服务的多数功能，无需离开终端。

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

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

有关Vault API的更多信息，请参阅官方文档站点。

安装和源代码

使用cargo安装命令行界面

cargo install google-vault1-cli

在github上找到源代码。

用法

此文档是从修订版20240220的Vault API生成的。CLI版本为5.0.4。

vault1 [options]
        matters
                add-permissions <matter-id> (-r <kv>)... [-p <v>]... [-o <out>]
                close <matter-id> (-r <kv>)... [-p <v>]... [-o <out>]
                count <matter-id> (-r <kv>)... [-p <v>]... [-o <out>]
                create (-r <kv>)... [-p <v>]... [-o <out>]
                delete <matter-id> [-p <v>]... [-o <out>]
                exports-create <matter-id> (-r <kv>)... [-p <v>]... [-o <out>]
                exports-delete <matter-id> <export-id> [-p <v>]... [-o <out>]
                exports-get <matter-id> <export-id> [-p <v>]... [-o <out>]
                exports-list <matter-id> [-p <v>]... [-o <out>]
                get <matter-id> [-p <v>]... [-o <out>]
                holds-accounts-create <matter-id> <hold-id> (-r <kv>)... [-p <v>]... [-o <out>]
                holds-accounts-delete <matter-id> <hold-id> <account-id> [-p <v>]... [-o <out>]
                holds-accounts-list <matter-id> <hold-id> [-p <v>]... [-o <out>]
                holds-add-held-accounts <matter-id> <hold-id> (-r <kv>)... [-p <v>]... [-o <out>]
                holds-create <matter-id> (-r <kv>)... [-p <v>]... [-o <out>]
                holds-delete <matter-id> <hold-id> [-p <v>]... [-o <out>]
                holds-get <matter-id> <hold-id> [-p <v>]... [-o <out>]
                holds-list <matter-id> [-p <v>]... [-o <out>]
                holds-remove-held-accounts <matter-id> <hold-id> (-r <kv>)... [-p <v>]... [-o <out>]
                holds-update <matter-id> <hold-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                remove-permissions <matter-id> (-r <kv>)... [-p <v>]... [-o <out>]
                reopen <matter-id> (-r <kv>)... [-p <v>]... [-o <out>]
                saved-queries-create <matter-id> (-r <kv>)... [-p <v>]... [-o <out>]
                saved-queries-delete <matter-id> <saved-query-id> [-p <v>]... [-o <out>]
                saved-queries-get <matter-id> <saved-query-id> [-p <v>]... [-o <out>]
                saved-queries-list <matter-id> [-p <v>]... [-o <out>]
                undelete <matter-id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <matter-id> (-r <kv>)... [-p <v>]... [-o <out>]
        operations
                cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                delete <name> [-p <v>]... [-o <out>]
                get <name> [-p <v>]... [-o <out>]
                list <name> [-p <v>]... [-o <out>]
  vault1 --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文件中，文件名以vault1-开头。您可以使用--config-dir标志在每次调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

首次使用作用域时，系统会要求用户进行授权。根据CLI的说明进行授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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