2.2 KiB
2.2 KiB
td
Install (this was generated by Ink starter, dunno if that works)
$ npm install --global td
Dependencies
-
fzf https://github.com/junegunn/fzf
- for searching & selectors
-
tmux https://github.com/tmux/tmux/wiki
- for displaying an editor in a side pane
- IMPORTANT: this app must be run inside tmux
- Ive got a comfy tmux config I can share later if U'd want it :)
-
OPTIONAL neovim https://github.com/neovim/neovim
- rly not
dat badonce u get used to it - https://www.lazyvim.org is an excellent starting point (da one I use still) but requires some more dependencies
- rly not
ENV vars
TD_EDITOR
Editor for ask editing, CLI only (recommend neovim (again Ive got a comfy config I can share later if U'd want it :)))
can be set to e.g. nano or vi in a pinch
TD_TASK_DIR
Directory for storing tasks.json and logs. Assumed to be a git repo
set them before running td
$ tmux
$ export TD_EDITOR=nvim
$ export TD_TASK_DIR=/home/omnissiah/git/tasks/
$ npm run buid
$ node dist/cli.js
or in Your .bashrc
Manual
P.S. A more complete (but dunno if complete) summary of keybinds can be displayed on ? keybind
-
Task Management:
- Create, edit, delete tasks.
- View lists in a ranger-like UI https://github.com/ranger/ranger
- Tasks can have subtasks.
- Create, edit, delete tasks.
-
Navigation:
- Vim-like keybindings for navigation:
hjklto navigate in and between subtask lists.HJKLto move a task in and between subtask lists.gto go to the top of the list.Gto go to the bottom of the list.dto go down 5 tasksuto go up 5 tasksDto delete a task (with a confirmation dialog)xto cut a taskpto paste a cut task
-
Task Operations:
ato add a new task.Ato add a new subtask.ato add a new task.eto edit the selected task using external editor.dto delete the selected task. (with confirmation using fzf)spaceto toggle the completion status of a task.
-
External Editor:
- Uses neovim for text editing.
-
Persistence:
- Save and load tasks from a file
-
Search:
/to search for tasks (fzf).
-
Help:
?to show help for keybindings.