/taskwarrior-tui

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

Primary LanguageRustMIT LicenseMIT

taskwarrior-tui

CI

A Terminal User Interface for Taskwarrior.

Installation

Unless otherwise specified, you will need to install taskwarrior first. See https://taskwarrior.org/download/ for more information.

Manual ( Recommended )

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

Install from source 

git clone https://github.com/kdheepak/taskwarrior-tui.git
cd taskwarrior-tui
cargo build --release

Using brew

This installs task from homebrew as well.

brew install taskwarrior-tui

Install from AUR

Use your favorite installation method to download from the AUR git maintained by @loki7990. For example:

yay -S taskwarrior-tui-git # build from source master

Or use your favorite installation method to download from the AUR latest release or the AUR precompiled binaries maintained by @orhun. For example:

yay -S taskwarrior-tui # build from source latest release
# Or
yay -S taskwarrior-tui-bin # download precompiled binaries

Using snap 

snap install taskwarrior-tui

Using zdharma/zinit

Add the following to your ~/.zshrc:

zinit ice wait:2 lucid extract"" from"gh-r" as"command" mv"taskwarrior-tui* -> tt"
zinit load kdheepak/taskwarrior-tui

Usage

See it in action:

Click to expand!

Easy to use interface:

Click to expand!

See KEYBINDINGS.md for full list.

Context switcher:

Click to expand!

readline-like functionality:

Click to expand!
  • <Ctrl-a> : Go to beginning of the line
  • <Ctrl-e> : Go to end of the line
  • <Ctrl-u> : Delete from beginning of the line
  • <Ctrl-k> : Delete to end of the line
  • <Ctrl-w> : Delete previous word

Calendar view

Click to expand!

taskwarrior-tui supports a Calendar view, which you can get to by hitting the ] key:

This highlights the days for your due tasks in a calendar view. You can configure the number of months in a row by changing the uda.taskwarrior-tui.calendar.months-per-row attribute in your taskrc file. See the next section for more information.

You can switch back to the task view by hitting the [ key.

Configure taskwarrior-tui using ~/.taskrc:

Click to expand!

taskwarrior-tui reads values from your taskwarrior's taskrc file (default: ~/.taskrc).

For example, color.active is used to style the active task. If you would like to try it, open your taskrc file and change color.active=white on blue.

So color.active will take precedence over color.overdue. You can see what color.active is by running task show color.active in your favorite shell prompt.

The following color attributes are supported:

color.deleted
color.completed
color.active
color.overdue
color.scheduled
color.due.today
color.due
color.blocked
color.blocking
color.recurring
color.tagged

Other taskwarrior-tui configuration options are possible using the user defined attribute feature of taskwarrior. All taskwarrior-tui specific configuration options will begin with uda.taskwarrior-tui.. The following is a full list of all the options available and their default values implemented by taskwarrior-tui if not defined in your taskrc file.

uda.taskwarrior-tui.selection.indicator=•
uda.taskwarrior-tui.selection.bold=yes
uda.taskwarrior-tui.selection.italic=no
uda.taskwarrior-tui.selection.dim=no
uda.taskwarrior-tui.selection.blink=no
uda.taskwarrior-tui.calendar.months-per-row=4
uda.taskwarrior-tui.task-report.show-detail=true
uda.taskwarrior-tui.task-report.looping=true
uda.taskwarrior-tui.style.context.active=black on rgb444
uda.taskwarrior-tui.style.calendar.title=black on rgb444