18个稳定版本 (4个主要版本)
5.0.4+20240304 | 2024年3月5日 |
---|---|
3.1.0+20220305 | 2022年4月26日 |
3.0.0+20220305 | 2022年3月8日 |
2.0.4+20210331 | 2021年4月14日 |
0.3.6+20150422 | 2016年9月11日 |
在 #blogger 中排名第1
每月下载381次
740KB
11K SLoC
blogger3
命令行界面(CLI)允许您从终端舒适地使用Google Blogger服务的几乎所有功能。
默认情况下,所有输出都打印到标准输出,但可以设置标志将其直接重定向到文件,而不依赖于shell的能力。错误将打印到标准错误,并导致程序退出代码非零。
如果请求数据结构,这些结构将作为格式化的JSON返回,以便作为其他工具的输入。
Blogger API的其他所有信息都可以在官方文档站点找到。
安装和源代码
使用cargo安装命令行界面
cargo install google-blogger3-cli
用法
本文档是根据版本20240304的Blogger API生成的。CLI的版本是5.0.4。
blogger3 [options]
blog-user-infos
get <user-id> <blog-id> [-p <v>]... [-o <out>]
blogs
get <blog-id> [-p <v>]... [-o <out>]
get-by-url <url> [-p <v>]... [-o <out>]
list-by-user <user-id> [-p <v>]... [-o <out>]
comments
approve <blog-id> <post-id> <comment-id> [-p <v>]... [-o <out>]
delete <blog-id> <post-id> <comment-id> [-p <v>]...
get <blog-id> <post-id> <comment-id> [-p <v>]... [-o <out>]
list <blog-id> <post-id> [-p <v>]... [-o <out>]
list-by-blog <blog-id> [-p <v>]... [-o <out>]
mark-as-spam <blog-id> <post-id> <comment-id> [-p <v>]... [-o <out>]
remove-content <blog-id> <post-id> <comment-id> [-p <v>]... [-o <out>]
page-views
get <blog-id> [-p <v>]... [-o <out>]
pages
delete <blog-id> <page-id> [-p <v>]...
get <blog-id> <page-id> [-p <v>]... [-o <out>]
insert <blog-id> (-r <kv>)... [-p <v>]... [-o <out>]
list <blog-id> [-p <v>]... [-o <out>]
patch <blog-id> <page-id> (-r <kv>)... [-p <v>]... [-o <out>]
publish <blog-id> <page-id> [-p <v>]... [-o <out>]
revert <blog-id> <page-id> [-p <v>]... [-o <out>]
update <blog-id> <page-id> (-r <kv>)... [-p <v>]... [-o <out>]
post-user-infos
get <user-id> <blog-id> <post-id> [-p <v>]... [-o <out>]
list <user-id> <blog-id> [-p <v>]... [-o <out>]
posts
delete <blog-id> <post-id> [-p <v>]...
get <blog-id> <post-id> [-p <v>]... [-o <out>]
get-by-path <blog-id> <path> [-p <v>]... [-o <out>]
insert <blog-id> (-r <kv>)... [-p <v>]... [-o <out>]
list <blog-id> [-p <v>]... [-o <out>]
patch <blog-id> <post-id> (-r <kv>)... [-p <v>]... [-o <out>]
publish <blog-id> <post-id> [-p <v>]... [-o <out>]
revert <blog-id> <post-id> [-p <v>]... [-o <out>]
search <blog-id> <q> [-p <v>]... [-o <out>]
update <blog-id> <post-id> (-r <kv>)... [-p <v>]... [-o <out>]
users
get <user-id> [-p <v>]... [-o <out>]
blogger3 --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文件中,这些文件以blogger3-
为前缀。您可以使用--config-dir
标志在每次调用中更改用于存储配置的目录。
以下段落提供了有关各种类型持久数据的更多信息。
身份验证
大多数API要求用户对任何请求进行身份验证。如果是这样,则范围确定授予的权限集。这些的粒度通常不超过只读或完全访问。
如果没有设置,系统将自动选择最小的可行范围,例如,当调用只读方法时,它将只请求只读范围。您可以使用--scope
标志直接指定范围。所有适用的范围均在相应方法的CLI文档中记录。
第一次使用范围时,系统会要求用户授权。按照CLI给出的说明授权权限,或拒绝授权。
如果作用域被用户验证,相关信息将被存储在配置目录中,格式为JSON,例如~/.google-service-cli/blogger3-token-<scope-hash>.json
。不需要手动管理这些令牌。
要撤销授权的验证,请参阅官方文档。
应用程序密钥
为了允许任何应用程序使用Google服务,它需要使用Google开发者控制台进行注册。应用程序可能使用的API将逐个启用。大多数API可以免费使用,并有每日配额。
为了在不强迫任何人注册自己的应用程序的情况下更方便地使用CLI,CLI自带了一个默认的应用程序密钥,相应地进行了配置。这也意味着全球范围内的频繁使用可能会耗尽每日配额。
您可以通过将您自己的密钥文件放在此位置来解决这个问题:~/.google-service-cli/blogger3-secret.json
,假设已为它启用了所需的blogger API。这样的密钥文件可以从Google开发者控制台在APIs & auth -> Credentials -> Download JSON中下载,并直接使用。
有关如何设置Google项目和启用API的更多信息,请参阅官方文档。
调试
尽管CLI尽最大努力提供可用的错误消息,但有时可能需要了解导致特定问题的确切原因。这是通过允许所有客户端-服务器通信以原始形式输出到标准错误。
使用--debug
标志将错误以Debug
表示形式打印到标准错误。
您可以考虑将标准错误重定向到文件以方便使用,例如blogger3 --debug <resource> <method> [options] 2>debug.txt
。
依赖项
~20–31MB
~576K SLoC