# `taskwarrior-tui`
[](https://github.com/kdheepak/taskwarrior-tui/actions?query=workflow%3ACI)
[](./LICENSE)
[](https://github.com/kdheepak/taskwarrior-tui/releases/latest)
[](https://github.com/kdheepak/taskwarrior-tui/releases/latest)
[](https://github.com/kdheepak/taskwarrior-tui)
[](https://coveralls.io/github/kdheepak/taskwarrior-tui)
[](https://kdheepak.com/taskwarrior-tui)
A Terminal User Interface for [Taskwarrior](https://taskwarrior.org/) that you didn't know you wanted.
### Features
- vim-like navigation
- add, delete, complete, log tasks from TUI
- multiple selection
- tab completion
- colors based on taskwarrior
### Showcase
Showcase of features: https://youtu.be/0ZdkfNrIAcw
User Interface: (gif)
Multiple selection: (gif)
Tab completion: (gif)
### Documentation
See https://kdheepak.com/taskwarrior-tui for
documentation.
See https://kdheepak.com/taskwarrior-tui/installation/ for
installation instructions for your platform.
See https://kdheepak.com/taskwarrior-tui/quick_start/ to get
started.
See https://kdheepak.com/taskwarrior-tui/configuration/keys
or https://kdheepak.com/taskwarrior-tui/configuration/colors/
for customization options.
### Installation
Unless otherwise specified, you will need to install the latest version of `taskwarrior` first. See for more information.
**Manual** [](https://github.com/kdheepak/taskwarrior-tui/releases/latest) [](https://github.com/kdheepak/taskwarrior-tui/releases/latest)
1. Download the tar.gz file for your OS from [the latest release](https://github.com/kdheepak/taskwarrior-tui/releases/latest).
2. Unzip the tar.gz file
3. Run with `./taskwarrior-tui`.
See on instructions for using package managers on various platforms.
If you are compiling from source, you'll need to most recent stable rust compiler.
### Configuration
`taskwarrior-tui` uses `taskwarrior`'s `.taskrc` for configuration.
See the documentation for more information:
-
-
-
Here is an example `.taskrc`
```.taskrc
### taskwarrior configuration options
# taskwarrior's configuration
data.location=.task
verbose=affected,blank,context,edit,header,footnote,label,new-id,project,special,sync,recur
uda.priority.values=H,M,,L
color.alternate=
# taskwarrior-tui reads color attributes from the following to display the same colors of tasks as the CLI
color.tagged=black on rgb444
# Remove age, tags from task next report.
# taskwarrior-tui reads the labels and columns from these options to display tasks the same way taskwarrior does
report.next.labels=ID,Active,Age,Deps,P,Project,Tag,Recur,S,Due,Until,Description,Urg
report.next.columns=id,start.age,entry.age,depends,priority,project,tags,recur,scheduled.countdown,due.relative,until.remaining,description.truncated_count,urgency
report.next.filter=(status:pending or status:waiting) page:limit
### taskwarrior-tui configuration options
uda.taskwarrior-tui.keyconfig.done=x
uda.taskwarrior-tui.keyconfig.delete=d
uda.taskwarrior-tui.shortcuts.0=~/local/bin/task-sync.sh
uda.taskwarrior-tui.report.next.filter=(status:pending or status:waiting)
```
### References / Resources
If you like `taskwarrior-tui`, please consider donating to [@GothenburgBitFactory](https://github.com/GothenburgBitFactory):
Additional resources