drive2 命令行界面 (CLI) 允许您从终端舒适地使用 Google drive 服务的多数功能。

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

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

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

安装和源代码

使用 cargo 安装命令行界面

cargo install google-drive2-cli

在 GitHub 上找到源代码。

用法

本文档是根据修订 20240227 的 drive API 生成的。CLI 的版本为 5.0.4。

drive2 [options]
        about
                get [-p <v>]... [-o <out>]
        apps
                get <app-id> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
        changes
                get <change-id> [-p <v>]... [-o <out>]
                get-start-page-token [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                watch (-r <kv>)... [-p <v>]... [-o <out>]
        channels
                stop (-r <kv>)... [-p <v>]...
        children
                delete <folder-id> <child-id> [-p <v>]...
                get <folder-id> <child-id> [-p <v>]... [-o <out>]
                insert <folder-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <folder-id> [-p <v>]... [-o <out>]
        comments
                delete <file-id> <comment-id> [-p <v>]...
                get <file-id> <comment-id> [-p <v>]... [-o <out>]
                insert <file-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <file-id> [-p <v>]... [-o <out>]
                patch <file-id> <comment-id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <file-id> <comment-id> (-r <kv>)... [-p <v>]... [-o <out>]
        drives
                delete <drive-id> [-p <v>]...
                get <drive-id> [-p <v>]... [-o <out>]
                hide <drive-id> [-p <v>]... [-o <out>]
                insert <request-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                unhide <drive-id> [-p <v>]... [-o <out>]
                update <drive-id> (-r <kv>)... [-p <v>]... [-o <out>]
        files
                copy <file-id> (-r <kv>)... [-p <v>]... [-o <out>]
                delete <file-id> [-p <v>]...
                empty-trash [-p <v>]...
                export <file-id> <mime-type> [-p <v>]... [-o <out>]
                generate-ids [-p <v>]... [-o <out>]
                get <file-id> [-p <v>]... [-o <out>]
                insert (-r <kv>)... (-u simple -f <file> [-m <mime>]) [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                list-labels <file-id> [-p <v>]... [-o <out>]
                modify-labels <file-id> (-r <kv>)... [-p <v>]... [-o <out>]
                patch <file-id> (-r <kv>)... [-p <v>]... [-o <out>]
                touch <file-id> [-p <v>]... [-o <out>]
                trash <file-id> [-p <v>]... [-o <out>]
                untrash <file-id> [-p <v>]... [-o <out>]
                update <file-id> (-r <kv>)... (-u simple -f <file> [-m <mime>]) [-p <v>]... [-o <out>]
                watch <file-id> (-r <kv>)... [-p <v>]... [-o <out>]
        parents
                delete <file-id> <parent-id> [-p <v>]...
                get <file-id> <parent-id> [-p <v>]... [-o <out>]
                insert <file-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <file-id> [-p <v>]... [-o <out>]
        permissions
                delete <file-id> <permission-id> [-p <v>]...
                get <file-id> <permission-id> [-p <v>]... [-o <out>]
                get-id-for-email <email> [-p <v>]... [-o <out>]
                insert <file-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <file-id> [-p <v>]... [-o <out>]
                patch <file-id> <permission-id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <file-id> <permission-id> (-r <kv>)... [-p <v>]... [-o <out>]
        properties
                delete <file-id> <property-key> [-p <v>]...
                get <file-id> <property-key> [-p <v>]... [-o <out>]
                insert <file-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <file-id> [-p <v>]... [-o <out>]
                patch <file-id> <property-key> (-r <kv>)... [-p <v>]... [-o <out>]
                update <file-id> <property-key> (-r <kv>)... [-p <v>]... [-o <out>]
        replies
                delete <file-id> <comment-id> <reply-id> [-p <v>]...
                get <file-id> <comment-id> <reply-id> [-p <v>]... [-o <out>]
                insert <file-id> <comment-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <file-id> <comment-id> [-p <v>]... [-o <out>]
                patch <file-id> <comment-id> <reply-id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <file-id> <comment-id> <reply-id> (-r <kv>)... [-p <v>]... [-o <out>]
        revisions
                delete <file-id> <revision-id> [-p <v>]...
                get <file-id> <revision-id> [-p <v>]... [-o <out>]
                list <file-id> [-p <v>]... [-o <out>]
                patch <file-id> <revision-id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <file-id> <revision-id> (-r <kv>)... [-p <v>]... [-o <out>]
        teamdrives
                delete <team-drive-id> [-p <v>]...
                get <team-drive-id> [-p <v>]... [-o <out>]
                insert <request-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                update <team-drive-id> (-r <kv>)... [-p <v>]... [-o <out>]
  drive2 --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 文件中，这些文件以 drive2- 为前缀。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

首次使用作用域时，会询问用户权限。按照CLI提供的说明授权或拒绝。

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

要撤销授权，请参考官方文档。

应用程序密钥

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

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

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

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

调试

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

使用--debug标志，错误将以Debug表示形式输出到标准错误。

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