file1 命令行界面（CLI）允许您从终端舒适地使用Google Cloud Filestore服务的多数功能。

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

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

有关Cloud Filestore API的所有其他信息，请参阅官方文档站点。

安装和源代码

使用cargo安装命令行界面

cargo install google-file1-cli

在GitHub上找到源代码。

用法

本文档是根据Cloud Filestore API在修订版20240126下生成的。CLI版本为5.0.4。

file1 [options]
        projects
                locations-backups-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-backups-delete <name> [-p <v>]... [-o <out>]
                locations-backups-get <name> [-p <v>]... [-o <out>]
                locations-backups-list <parent> [-p <v>]... [-o <out>]
                locations-backups-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-get <name> [-p <v>]... [-o <out>]
                locations-instances-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-delete <name> [-p <v>]... [-o <out>]
                locations-instances-get <name> [-p <v>]... [-o <out>]
                locations-instances-list <parent> [-p <v>]... [-o <out>]
                locations-instances-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-restore <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-revert <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-snapshots-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-snapshots-delete <name> [-p <v>]... [-o <out>]
                locations-instances-snapshots-get <name> [-p <v>]... [-o <out>]
                locations-instances-snapshots-list <parent> [-p <v>]... [-o <out>]
                locations-instances-snapshots-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-list <name> [-p <v>]... [-o <out>]
                locations-operations-cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-operations-delete <name> [-p <v>]... [-o <out>]
                locations-operations-get <name> [-p <v>]... [-o <out>]
                locations-operations-list <name> [-p <v>]... [-o <out>]
  file1 --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目录中存储所有持久数据，该目录使用以file1为前缀的JSON文件。您可以使用--config-dir标志在每次调用中更改用于存储配置的目录。

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

身份验证

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

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

第一次使用范围时，用户将被要求授予权限。遵循CLI提供的指示来授予权限或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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