kdheepak/taskwarrior-tui
1
0
Fork 0
mirror of https://github.com/kdheepak/taskwarrior-tui.git synced 2025-08-24 14:36:42 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
taskwarrior-tui/docs/configuration/advanced.md
Dheepak Krishnamurthy 83c848dc7c
Update advanced.md
2021-08-07 23:37:31 -06:00

3.1 KiB
Raw Blame History

Advanced configuration

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.mark.indicator=✔
uda.taskwarrior-tui.unmark.indicator= 
uda.taskwarrior-tui.mark-selection.indicator=⦿
uda.taskwarrior-tui.unmark-selection.indicator=⦾
uda.taskwarrior-tui.calendar.months-per-row=4
uda.taskwarrior-tui.task-report.show-info=true
uda.taskwarrior-tui.task-report.looping=true
uda.taskwarrior-tui.task-report.jump-on-task-add=true
uda.taskwarrior-tui.task-report.prompt-on-delete=false
uda.taskwarrior-tui.style.context.active=black on rgb444
uda.taskwarrior-tui.style.calendar.title=black on rgb444
uda.taskwarrior-tui.task-report.next.filter=$(task show report.next.filter)

Configure user defined shortcuts:

You can configure shortcuts to execute custom commands from your taskwarrior's taskrc file (default: ~/.taskrc). You can do this by mapping a shortcut to an executable file:

uda.taskwarrior-tui.shortcuts.1=~/.config/taskwarrior-tui/shortcut-scripts/add-personal-tag.sh
uda.taskwarrior-tui.shortcuts.2=~/.config/taskwarrior-tui/shortcut-scripts/sync.sh
...

The file can have any name in any location, but must be executable. By default, keys 1-9 are available to run shortcuts.

When you hit the shortcut, the script will be executed with the selected_task_uuid as an argument:

~/.config/taskwarrior-tui/shortcut-scripts/add-personal-tag.sh $selected_tasks_uuid

For example, you can add the personal tag to the currently selected task with the following script in ~/.config/taskwarrior-tui/shortcut-scripts/add-personal-tag.sh :

task rc.bulk=0 rc.confirmation=off rc.dependency.confirmation=off rc.recurrence.confirmation=off "$@" modify +personal

By default, shortcuts are linked to the 1-9 number row keys. They can be customized as any other keys through uda.taskwarrior-tui.keyconfig.shortcut1=<key>. For example:

uda.taskwarrior-tui.keyconfig.shortcut1=n

You can set up shortcuts to run task sync or any custom bash script that you'd like.

Configure one background task

You can configure one background task to run periodically:

uda.taskwarrior-tui.background_process=task sync
uda.taskwarrior-tui.background_process_period=60

This will run task sync every 60 seconds. If the background_process is an empty string (default), then no process will be run. Only if the background_process is defined and if the background_process runs successfully, it'll be run every background_process_period number of seconds (default: 60 seconds). However, if it fails even once it won't be run again till taskwarrior-tui is restarted.