Taskbook-终端内管理任务和笔记

| 安装与使用

安装：npm install --global taskbook

Options

none 显示板块视图 –find, -f 搜索条目
–task, -t 创建任务 –edit, -e 编辑条目描述
–note, -n 创建笔记 –move, -m 在板块之间移动条目
–timeline, -i 显示时间线视图 –priority, -p 更新任务的优先级
–delete, -d 删除条目 –archive, -a 显示已归档的条目
–check, -c 选中/取消选中任务 –restore, -r 从存档还原条目
–star, -s Star/unstar 条目 –help, -h 显示帮助信息
–list, -l 按属性列出条目 –version, -v 显示已安装的版本

Examples

$ tb $ tb –move @1 cooking
$ tb –task Make some buttercream $ tb –check 1 2
$ tb –task @coding Improve documentation $ tb –delete 4
$ tb –task @coding @reviews Review PR #42 $ tb –star 2
$ tb –note @coding Mergesort worse-case O(nlogn) $ tb –priority @3 2
$ tb –edit @3 Merge PR #42 $ tb –timeline
$ tb –find documentation $ tb –archive
$ tb –list pending coding $ tb –restore 4

| 详细说明

  1. 创建板块： 指定板块不存在，会自动新建并初始化板块。若想将新的任务条目指定给新的板块，那么可以在任务描述前，使用@作为前缀，并加上新的板块名称（可以多个板块一并创建）。 此时，新创建的任务条目将属于所有给定的板块。如果任务条目描述中不包含任何板块名称，那么默认情况下，会自动添加到通用的：My Board。

    $ tb -t @coding @docs Update contributing guidelines

  2. 完成任务：将任务标记为『完成/待处理』，使用 –check/-c 选项后跟目标任务的 ID。 done/pending（完成/待处理）状态。因此，『done』 -> 『pending』；『pending』 -> 『done』。 重复的ID会自动过滤掉。

  3. 设置优先级：要在初始化任务时设置任务的优先级，请包括p:x任务描述中的语法。 其中x可以是值的整数1- 正常优先、2- 中等优先级、3- 高度优先。请注意，默认情况下，所有任务都以正常优先级1创建。要在创建特定任务后更新特定任务的优先级，请使用–priority/-p选项，紧接着是@id（任务条目的id），最后是优先等级。 目标ID和优先级的放置顺序 并不重要。

    $ tb -t @coding Fix issue #42 p:3

4.列出条目：板块名称和条目特征可以被视为有效的列表属性。例如，列出属于默认值的所有条目myboard并且是待定任务，可以使用以下内容：$ tb -l myboard pending。默认支持的列表属性及其各自的别名如下:

myboard - 属于My Board的条目 task, tasks, todo - 作为任务的条目
note, notes - 作为笔记的条目 pending, unchecked, incomplete - 待处理的任务条目
done, checked, complete - 已完成的任务条目 star, starred - 已加星标的条目

| 配置

要配置 taskbook ，可定位到~/.taskbook.json并根据您的个人喜好修改任何配置选项。如果要重置回默认值，只需从主目录中删除配置文件即可。

以下说明了所有可用选项及其各自的默认值：

{
  "taskbookDirectory": "",
  "displayCompleteTasks": true,
  "displayProgressOverview": true
}

配置细节

  • taskbookDirectory 类型: String 默认: ~ 初始化存储完成文件的系统路径，比如：/home/username/the-cloud

    如果未配置本选项，将默认设置为~/.taskbook/

  • displayCompleteTasks 类型: Boolean 默认: true 显示标记为完成的任务

  • displayProgressOverview 类型: Boolean 默认: true 在时间线和任务板视图下方显示进度概述

| 参考链接

Taskbook