19 个稳定版本 (4 个主要版本)
5.0.4+20240303 | 2024年3月5日 |
---|---|
3.1.0+20220305 | 2022年4月26日 |
3.0.0+20220305 | 2022年3月8日 |
2.0.4+20210329 | 2021年4月15日 |
0.3.6+20141121 | 2016年9月11日 |
在 Web编程 中排名 #2469
每月下载 42 次
340KB
5K SLoC
tasks1 命令行界面 (CLI) 允许您在终端舒适地使用Google Tasks服务的多数功能。
默认情况下,所有输出都打印到标准输出,但可以设置标志将其定向到文件,而与您的shell功能无关。错误将打印到标准错误,并导致程序退出代码不为零。
如果请求数据结构,则这些结构将作为格式化的JSON返回,以作为其他工具的输入使用。
关于Tasks API的所有其他信息可以在 官方文档网站 找到。
安装和源代码
使用cargo安装命令行界面:
cargo install google-tasks1-cli
在 GitHub上找到源代码。
用法
此文档是根据修订版 20240303 的 Tasks API 生成的。CLI版本为 5.0.4。
tasks1 [options]
tasklists
delete <tasklist> [-p <v>]...
get <tasklist> [-p <v>]... [-o <out>]
insert (-r <kv>)... [-p <v>]... [-o <out>]
list [-p <v>]... [-o <out>]
patch <tasklist> (-r <kv>)... [-p <v>]... [-o <out>]
update <tasklist> (-r <kv>)... [-p <v>]... [-o <out>]
tasks
clear <tasklist> [-p <v>]...
delete <tasklist> <task> [-p <v>]...
get <tasklist> <task> [-p <v>]... [-o <out>]
insert <tasklist> (-r <kv>)... [-p <v>]... [-o <out>]
list <tasklist> [-p <v>]... [-o <out>]
move <tasklist> <task> [-p <v>]... [-o <out>]
patch <tasklist> <task> (-r <kv>)... [-p <v>]... [-o <out>]
update <tasklist> <task> (-r <kv>)... [-p <v>]... [-o <out>]
tasks1 --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 文件中,文件名以 tasks1-
开头。您可以使用 --config-dir
标志在每个调用的基础上更改用于存储配置的目录。
以下段落提供了有关各种类型持久数据的更多信息。
身份验证
大多数API需要用户对请求进行身份验证。如果是这种情况,作用域 确定了授予的权限集。这些的粒度通常不超过 只读 或 完全访问。
如果没有设置,系统将自动选择最小的可行作用域,例如,在调用只读方法时,它只会请求只读作用域。您可以使用 --scope
标志直接指定作用域。所有适用的作用域都在相应方法的CLI文档中记录。
首次使用作用域时,会要求用户授权。根据CLI的指示进行授权或拒绝。
如果用户认证了某个作用域,相应的信息将作为JSON存储在配置目录中,例如:~/.google-service-cli/tasks1-token-<scope-hash>.json
。无需手动管理这些令牌。
要撤销授权,请参考官方文档。
应用程序密钥
为了允许任何应用程序使用Google服务,需要使用Google开发者控制台进行注册。然后为该应用程序逐个启用可能使用的API。大多数API可以免费使用,并设有每日配额。
为了在不强制用户注册自己的应用程序的情况下更舒适地使用CLI,CLI包含一个默认应用程序密钥,相应地进行了配置。这也意味着全球范围内的重用可能会耗尽每日配额。
您可以通过在此位置放置自己的密钥文件来解决这个问题:~/.google-service-cli/tasks1-secret.json
,假设已为它启用了所需的tasks API。这样的密钥文件可以在Google开发者控制台的APIs & auth -> Credentials -> Download JSON中下载并直接使用。
有关如何设置Google项目和启用API的更多信息,请参阅官方文档。
调试
尽管CLI尽力提供可用的错误消息,但有时可能希望了解导致特定问题的确切原因。这是通过允许所有客户端服务器通信以原样输出到标准错误来完成的。
使用--debug
标志将以Debug
表示形式将错误打印到标准错误。
您可以考虑将标准错误重定向到文件以便于使用,例如:tasks1 --debug <resource> <method> [options] 2>debug.txt
。
依赖关系
~20–31MB
~580K SLoC