12个稳定版本 (3个主要版本)
5.0.4+20240223 | 2024年3月5日 |
---|---|
3.1.0+20220303 | 2022年4月26日 |
3.0.0+20220303 | 2022年3月8日 |
2.0.4+20210331 | 2021年4月15日 |
1.0.8+20181004 | 2018年10月14日 |
#75 in #命令行界面
500KB
6.5K SLoC
该 photoslibrary1
命令行界面(CLI)允许您在终端中方便地使用 Google 照片库服务的大多数功能。
默认情况下,所有输出都打印到标准输出,但可以通过设置标志将其重定向到文件,而无需依赖 shell 的功能。错误将打印到标准错误,并导致程序退出代码不为零。
如果请求数据结构,则这些数据结构将作为格式化的 JSON 返回,以便作为其他工具的输入使用。
有关照片库 API 的所有其他信息,请参阅官方文档网站。
安装和源代码
使用 cargo 安装命令行界面:
cargo install google-photoslibrary1-cli
在 github 上找到源代码。
用法
此文档是从 照片库 API 的修订版 20240223 生成的。CLI 的版本为 5.0.4。
photoslibrary1 [options]
albums
add-enrichment <album-id> (-r <kv>)... [-p <v>]... [-o <out>]
batch-add-media-items <album-id> (-r <kv>)... [-p <v>]... [-o <out>]
batch-remove-media-items <album-id> (-r <kv>)... [-p <v>]... [-o <out>]
create (-r <kv>)... [-p <v>]... [-o <out>]
get <album-id> [-p <v>]... [-o <out>]
list [-p <v>]... [-o <out>]
patch <id> (-r <kv>)... [-p <v>]... [-o <out>]
share <album-id> (-r <kv>)... [-p <v>]... [-o <out>]
unshare <album-id> (-r <kv>)... [-p <v>]... [-o <out>]
media-items
batch-create (-r <kv>)... [-p <v>]... [-o <out>]
batch-get [-p <v>]... [-o <out>]
get <media-item-id> [-p <v>]... [-o <out>]
list [-p <v>]... [-o <out>]
patch <id> (-r <kv>)... [-p <v>]... [-o <out>]
search (-r <kv>)... [-p <v>]... [-o <out>]
shared-albums
get <share-token> [-p <v>]... [-o <out>]
join (-r <kv>)... [-p <v>]... [-o <out>]
leave (-r <kv>)... [-p <v>]... [-o <out>]
list [-p <v>]... [-o <out>]
photoslibrary1 --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 文件中。您可以使用 --config-dir
标志在每个调用的基础上更改用于存储配置的目录。
以下段落提供了有关各种类型持久数据的更多信息。
身份验证
大多数 API 需要用户对请求进行身份验证。如果是这种情况,则范围确定授予的权限集。这些范围通常不超过 只读 或 完全访问。
如果未设置,则系统将自动选择最小的可行范围,例如,在调用只读方法时,它只会请求只读范围。您可以使用 --scope
标志直接指定范围。有关所有适用范围的信息,请参阅相应方法的 CLI 文档。
首次使用作用域时,会要求用户授权。按照CLI给出的指示授予权限或拒绝。
如果作用域已被用户认证,相关信息将以JSON格式存储在配置目录中,例如~/.google-service-cli/photoslibrary1-token-<scope-hash>.json
。无需手动管理这些令牌。
要撤销授权,请参阅官方文档。
应用程序密钥
为了允许任何应用程序使用Google服务,它需要使用Google开发者控制台进行注册。应用程序可能使用的API将逐一启用。大多数API可以免费使用,并有每日配额。
为了在不强制用户注册自己的应用程序的情况下更方便地使用CLI,CLI自带了一个相应的默认应用程序密钥。这也意味着全球范围内的重用可能会耗尽每日配额。
您可以通过将您自己的密钥文件放置在此位置来解决这个问题:~/.google-service-cli/photoslibrary1-secret.json
,假设已为它启用了所需的photoslibrary API。这样的密钥文件可以从Google开发者控制台在APIs & auth -> Credentials -> Download JSON下载并直接使用。
有关如何设置Google项目和启用API的更多信息,请参阅官方文档。
调试
尽管CLI尽力提供可用的错误消息,但有时可能需要了解导致特定问题的确切原因。这是通过允许所有客户端-服务器通信以原样输出到标准错误来完成的。
使用--debug
标志将使用Debug
表示法将错误打印到标准错误。
您可以考虑将标准错误重定向到文件,以便于使用,例如photoslibrary1 --debug <resource> <method> [options] 2>debug.txt
。
依赖项
~20–31MB
~577K SLoC