iq-scm / taskwarrior-tui

`taskwarrior-tui`: A terminal user interface for taskwarrior

taskwarrior-tui

A Terminal User Interface (TUI) for Taskwarrior that you didn't know you wanted.

Features

• vim-like navigation
• live filter updates
• add, delete, complete, log tasks
• multiple selection
• tab completion
• colors based on taskwarrior

Showcase

Demo: (video)

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 https://taskwarrior.org/download/ for more information.

Pre-compiled releases are available on the GitHub repo:

1. Download the tar.gz file for your OS from the latest release.
2. Unzip the tar.gz file
3. Run with ./taskwarrior-tui.

See https://kdheepak.com/taskwarrior-tui/installation/ 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:

• https://kdheepak.com/taskwarrior-tui/configuration/keys
• https://kdheepak.com/taskwarrior-tui/configuration/colors
• https://kdheepak.com/taskwarrior-tui/configuration/advanced/

Here is an example `.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 me, @GothenburgBitFactory or a charity of your choice.

Additional resources

• https://github.com/GothenburgBitFactory/taskwarrior
• https://github.com/GothenburgBitFactory/libshared
• https://github.com/GothenburgBitFactory/timewarrior
• https://github.com/fdehau/tui-rs
• https://github.com/crossterm-rs/crossterm/
• https://github.com/async-rs/async-std
• https://github.com/kkawakam/rustyline
• https://github.com/vit-project/vit
• https://github.com/taskchampion/taskchampion/