27个稳定版本 (5个主要版本)

5.0.4+20240227 2024年3月5日
5.0.2-beta-1+202202252022年10月20日
4.0.4+20220225 2022年10月1日
4.0.1+20220225 2022年7月25日
0.3.6+20160901 2016年9月11日

#2 in #drive

MIT 许可证

1.5MB
17K SLoC

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

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

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

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

安装和源代码

使用cargo安装命令行界面:

cargo install google-drive3-cli

GitHub上找到源代码。

用法

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

drive3 [options]
        about
                get [-p <v>]... [-o <out>]
        apps
                get <app-id> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
        changes
                get-start-page-token [-p <v>]... [-o <out>]
                list <page-token> [-p <v>]... [-o <out>]
                watch <page-token> (-r <kv>)... [-p <v>]... [-o <out>]
        channels
                stop (-r <kv>)... [-p <v>]...
        comments
                create <file-id> (-r <kv>)... [-p <v>]... [-o <out>]
                delete <file-id> <comment-id> [-p <v>]...
                get <file-id> <comment-id> [-p <v>]... [-o <out>]
                list <file-id> [-p <v>]... [-o <out>]
                update <file-id> <comment-id> (-r <kv>)... [-p <v>]... [-o <out>]
        drives
                create <request-id> (-r <kv>)... [-p <v>]... [-o <out>]
                delete <drive-id> [-p <v>]...
                get <drive-id> [-p <v>]... [-o <out>]
                hide <drive-id> [-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>]
                create (-r <kv>)... (-u simple -f <file> [-m <mime>]) [-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>]
                list [-p <v>]... [-o <out>]
                list-labels <file-id> [-p <v>]... [-o <out>]
                modify-labels <file-id> (-r <kv>)... [-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>]
        permissions
                create <file-id> (-r <kv>)... [-p <v>]... [-o <out>]
                delete <file-id> <permission-id> [-p <v>]...
                get <file-id> <permission-id> [-p <v>]... [-o <out>]
                list <file-id> [-p <v>]... [-o <out>]
                update <file-id> <permission-id> (-r <kv>)... [-p <v>]... [-o <out>]
        replies
                create <file-id> <comment-id> (-r <kv>)... [-p <v>]... [-o <out>]
                delete <file-id> <comment-id> <reply-id> [-p <v>]...
                get <file-id> <comment-id> <reply-id> [-p <v>]... [-o <out>]
                list <file-id> <comment-id> [-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>]
                update <file-id> <revision-id> (-r <kv>)... [-p <v>]... [-o <out>]
        teamdrives
                create <request-id> (-r <kv>)... [-p <v>]... [-o <out>]
                delete <team-drive-id> [-p <v>]...
                get <team-drive-id> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                update <team-drive-id> (-r <kv>)... [-p <v>]... [-o <out>]
  drive3 --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文件中,以drive3-为前缀。您可以使用--config-dir标志在每个调用基础上更改用于存储配置的目录。

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

身份验证

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

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

第一次使用作用域时,系统会要求用户授权。遵循CLI给出的指示授予权限或拒绝。

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

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

应用程序密钥

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

为了使CLI更便于使用,而不必强迫任何人注册自己的应用程序,CLI自带了一个默认的应用程序密钥,并进行了相应的配置。这也意味着全球范围内的频繁使用可能会耗尽每日配额。

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

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

调试

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

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

您可以考虑将标准错误重定向到文件,以便于使用,例如drive3 --debug <资源> <方法> [选项] 2>debug.txt

依赖关系

~20–31MB
~578K SLoC