taskbook

「 📓 命令行的任务，板块和笔记」

校对 ✅

翻译的原文	与日期	最新更新	更多
commit	⏰ 2018 7.31		中文翻译

贡献

欢迎 👏 勘误/校对/更新贡献 😊 具体贡献请看

生活

If help, buy me coffee —— 营养跟不上了，给我来瓶营养快线吧! 💰

Taskbook

📓 任务，板块和笔记都在命令行这个栖息地

描述

通过使用简单且最小化的使用语法,平坦的学习曲线,使您可以在终端内跨多个板块,有效地管理任务和笔记. 所有数据都以原子方式写入存储,以防止损坏,并且永远不会与任何第三方实体共享. 已删除的项目会自动存档,并且可以随时完成或恢复.

访问贡献指南了解有关如何将此文档翻译成更多语言的更多信息.

来Gitter要么推特分享您对项目的看法.

强调

组织任务和笔记到板块
板块和时间表视图
优先和喜爱的机制
搜索和过滤项目
存档并恢复已删除的项目
轻巧快速
数据以原子方式写入存储
自定义存储位置
进展概述
简单和最小的使用语法
更新通知
可配置通过~/.taskbook.json
数据存储在 JSON 文件中~/.taskbook/storage

查看强调特性taskbook 黑板报.

安装

npm install --global taskbook

用法

$ tb --help

  Usage
    $ tb [<options> ...]

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

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

查看

板块视图

在没有任何选项的情况下调用 taskbook ,将显示分组到各自板中的所有已保存项目.

时间线视图

为了显示时间线视图中的所有项目,根据其创建日期,--timeline/-i选项可以使用.

配置

要配置 taskbook 导航到~/.taskbook.json并修改任何选项以符合您自己的偏好. 要重置回默认值,只需从主目录中删除配置文件即可.

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

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

详细

`taskbookDirectory`

类型: String
默认: ~

初始化存储完成文件的系统路径,即;/home/username/the-cloud

如果未定义,将设置~/.taskbook/.

`displayCompleteTasks`

类型: Boolean
默认: true

显示标记为完成的任务.

`displayProgressOverview`

类型: Boolean
默认: true

在时间线和电路板视图下方显示进度概述.

飞行手册

以下是一个小练习,其中包含一组有关如何使用 taskbook 的示例. 如果您发现错误或认为某个示例不够清晰并且应该进一步改进,请随时打开问题要么Pull 请求.

创建任务

要创建新任务,请使用--task/-t紧随其后的任务说明选项.

$ tb -t Improve documentation

创建笔记

要创建新笔记,请使用--note/-n紧跟着你的笔记正文的选项.

$ tb -n Mergesort worse-case O(nlogn)

创建板块

创建新任务或笔记时,会自动初始化板块. 要创建一个或多个板块,请包含其名称,前缀为@符号,在即将创建的项目的描述中. 因此,新创建的项目将属于所有给定的板块. 默认情况下,描述中不包含任何板块名称的项目会自动添加到通用的;My Board.

$ tb -t @coding @docs Update contributing guidelines

完成任务

要将任务标记为完成/未完成,请使用--check/-c选项后跟目标任务的 ID. 请注意,该选项将 switch-开关 给定任务的complete状态,因此完成任务 -> -c -> 待处理状态,待处理任务 -> -c -> 完成. 重复的 ID 会自动过滤掉.

$ tb -c 1 3

收藏物品

要将一个或多个项目标记为收藏,请使用--star/-s选项后跟目标项的 ID. 该选项的功能与上述功能相同--check选项.

$ tb -s 1 2 3

显示板块

在没有任何选项的情况下调用 taskbook 将显示分组到各自板中的所有已保存项目.

$ tb

显示时间轴

为了显示时间线视图中的所有项目,根据其创建日期,--timeline/-i选项可以使用.

$ tb -i

设置优先级

要在初始化任务时设置任务的优先级,请包括p:x任务描述中的语法,其中 x 可以是值的整数1,2要么3. 请注意,默认情况下,所有任务都以正常优先级-1创建.

1- 正常优先
2- 中等优先级
3- 高度优先

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

要在创建特定任务后更新特定任务的优先级,请使用--priority/-p选项以及 id 目标任务, id 是以前缀@符号和值的整数1,2要么3. 请注意,目标 ID 和优先级的放置顺序并不重要.

$ tb -p @1 2

移动项目

要将项目移动到一个或多个板块,请使用--move/-m选项,后跟目标ID,id 是以前缀为@符号和目标板块的名称. 默认值My board可以通过访问myboard关键词. 目标 ID 和电路板名称的放置顺序并不重要.

$ tb -m @1 myboard reviews

删除项目

要删除一个或多个项目,请使用--delete/-d选项后跟目标项的 ID. 请注意,已删除的项目会自动存档,并且可以随时完成或还原. 重复的 ID 会自动过滤掉.

$ tb -d 1 2

显示档案

要显示所有已存档项目,请使用--archive/-a选项. 请注意,所有已存档项目都会根据其创建日期显示在时间轴视图中.

$ tb -a

还原项目

要恢复一个或多个项目,请使用--restore/-r选项后跟目标项的 ID. 请注意,调用时可以看到所有已存档项目的 ID--archive/-a选项. 重复的 ID 会自动过滤掉.

$ tb -r 1 2

列出项目

要列出一组项目,其中每个项目符合特定数量的属性,请使用--list/-l选项后跟所需的属性. 板块名称和项目特征可以被视为有效的列表属性. 例如,列出属于默认值的所有项目myboard并且是待定任务,可以使用以下内容;

$ tb -l myboard pending

默认支持的列表属性及其各自的别名如下:

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

搜索项目

要搜索其中一个项目,请使用--find/-f选项,后跟您的搜索字词.

$ tb -f documentation

发展

有关如何为项目做出贡献的更多信息,请阅读贡献指南.

Fork 存储库并将其克隆到您的计算机
导航到您的本地 Fork: cd taskbook
安装项目依赖项: npm install要么yarn install
测试错误代码: npm test要么yarn test

有关

chalk- 终端字符串样式,干的好
signale- 可自制的控制台记录器

团队

Klaus Sinani (@klauscfhq)

执照

MIT

chinanf-boy / taskbook-zh Goto Github PK

taskbook-zh's Introduction

taskbook

校对 ✅

贡献

生活

Taskbook

📓 任务，板块 和 笔记 都在 命令行这个栖息地

目录

描述

强调

安装

用法

查看

板块视图

时间线视图

配置

详细

taskbookDirectory

displayCompleteTasks

displayProgressOverview