oh-my-todo

一个命令行的 TODO 工具

安装 [Install]

# npm
npm i oh-my-todo -g

# yarn
yarn global add oh-my-todo

# pnpm
pnpm i oh-my-todo -g

使用 [Usage]

添加一个待办事项

todo add <todoName>

例如：

$ todo add '完成 oh-my-todo 的文档'
✔︎ create successfully~

$ todo add '慢跑 30 分钟'
✔︎ create successfully~

这样我们就成功添加了两个待办

添加一个已完成状态的待办

todo add <taskName> -d

# or

todo add <taskName> --done

例如：

$ todo add '睡个好觉' -d
✔︎ create successfully~

显示所有待办事项

todo ls

例如：

$ todo ls
? 请选择想要操作的待办事项 (Use arrow keys)
❯ ⭕️ 01 - 完成 oh-my-todo 的文档
  ⭕️ 02 - 慢跑 30 分钟
  ✅ 03 - 睡个好觉

按 j 或 ↓ 可以向下选择待办

按 k 或 ↑ 可以向上选择待办

标记已完成

$ todo ls
? 请选择想要操作的待办事项 (Use arrow keys)
❯ ⭕️ 01 - 完成 oh-my-todo 的文档
  ⭕️ 02 - 慢跑 30 分钟
  ✅ 03 - 睡个好觉

选择待办后，按回车键进入操作模式。

$ todo ls
? 请选择想要操作的待办事项 ⭕️ 01 - 完成 oh-my-todo 的文档
? 请选择操作 (Use arrow keys)
❯ 标记已完成✅
  标记未完成⭕️
  删除待办事项🗑
  修改待办事项📝

然后选择 标记已完成✅ 按回车，就会将当前待办标记已完成。

$ todo ls
? 请选择想要操作的待办事项 (Use arrow keys)
❯ ✅ 01 - 完成 oh-my-todo 的文档
  ⭕️ 02 - 慢跑 30 分钟
  ✅ 03 - 睡个好觉

标记未完成

$ todo ls
? 请选择想要操作的待办事项
  ✅ 01 - 完成 oh-my-todo 的文档
  ⭕️ 02 - 慢跑 30 分钟
❯ ✅ 03 - 睡个好觉

选择待办后，进入操作模式

% todo ls
? 请选择想要操作的待办事项 ✅ 03 - 睡个好觉
? 请选择操作
  标记已完成✅
❯ 标记未完成⭕️
  删除待办事项🗑
  修改待办事项📝

然后选择 标记未完成⭕，按回车，将该待办标记为未完成。

$ todo ls
? 请选择想要操作的待办事项 (Use arrow keys)
❯ ✅ 01 - 完成 oh-my-todo 的文档
  ⭕️ 02 - 慢跑 30 分钟
  ⭕️ 03 - 睡个好觉

删除待办

$ todo ls
? 请选择想要操作的待办事项
  ✅ 01 - 完成 oh-my-todo 的文档
❯ ⭕️ 02 - 慢跑 30 分钟
  ⭕️ 03 - 睡个好觉

选择待办后，进入操作模式

$ todo ls
? 请选择想要操作的待办事项 ⭕️ 02 - 慢跑 30 分钟
? 请选择操作
  标记已完成✅
  标记未完成⭕️
❯ 删除待办事项🗑
  修改待办事项📝

然后选择 删除待办事项🗑，按回车，将该条待办删除。

% todo ls
? 请选择想要操作的待办事项 (Use arrow keys)
❯ ✅ 01 - 完成 oh-my-todo 的文档
  ⭕️ 02 - 睡个好觉

修改待办

% todo ls
? 请选择想要操作的待办事项 (Use arrow keys)
❯ ✅ 01 - 完成 oh-my-todo 的文档
  ⭕️ 02 - 睡个好觉

选择待办后，按回车进入操作模式。

$ todo ls
? 请选择想要操作的待办事项 ✅ 01 - 完成 oh-my-todo 的文档
? 请选择操作
  标记已完成✅
  标记未完成⭕️
  删除待办事项🗑
❯ 修改待办事项📝

选择 修改待办事项📝，按回车，进入输入模式，此时可以输入新待办的内容。

$ todo ls
? 请选择想要操作的待办事项 ✅ 01 - 完成 oh-my-todo 的文档
? 请选择操作 修改待办事项📝
? 请输入待办事项 完成 oh-my-todo 的文档 v1.0
📝 修改待办事项成功~

清除所有待办

todo clear

例如：

$ todo clear
🎉 clear successfully~