Troubleshooting
If taskwarrior-tui is slow, fails to start, or behaves differently than task, use this checklist to narrow the problem down before opening an issue.
Capture Version and Environment Details
Section titled “Capture Version and Environment Details”Start by recording the versions involved:
taskwarrior-tui --versiontask --versiontask diagnosticsIf you launch taskwarrior-tui with custom paths or wrappers, also record:
echo "$TASKRC"echo "$TASKDATA"echo "$TASKWARRIOR_TUI_DATA"echo "$TASKWARRIOR_TUI_TASKWARRIOR_CLI"These environment variables can help identify when there’s a bug in taskwarrior-tui versus a configuration or environment issue.
Collect a Log File
Section titled “Collect a Log File”taskwarrior-tui writes a taskwarrior-tui.log file to its data directory.
- By default it uses your platform’s local data directory.
- Override the log location with
--data /path/to/folderorTASKWARRIOR_TUI_DATA=/path/to/folder.
To enable verbose logs:
TASKWARRIOR_TUI_LOG_LEVEL=debug taskwarrior-tuiUse trace for the most verbose logs:
TASKWARRIOR_TUI_LOG_LEVEL=trace taskwarrior-tuiThe log includes timestamps on each line for logging information in taskwarrior-tui.
Compare With Plain Taskwarrior
Section titled “Compare With Plain Taskwarrior”Many issues are easier to isolate by comparing the presentation of the data in taskwarrior-tui with the underlying task commands directly. Use the same TASKRC, TASKDATA, report, and shell environment as the taskwarrior-tui session.
time task showtime task export nexttime task contexttime task summarytime task <uuid>Replace next with the report you open in taskwarrior-tui, and replace <uuid> with a task visible in the TUI view.
Isolate the UI Refresh Path
Section titled “Isolate the UI Refresh Path”Try these temporary taskrc changes one at a time:
uda.taskwarrior-tui.task-report.show-info=0uda.taskwarrior-tui.task-report.task-detail-prefetch=0uda.taskwarrior-tui.tick-rate=0What they help isolate:
task-report.show-info=0disables the task details pane.task-detail-prefetch=0keeps the details pane on, but reduces prefetching while you move through tasks.tick-rate=0disables periodic refresh ticks.
Restore your normal settings after the test.
Disable Local Customizations
Section titled “Disable Local Customizations”If you use any of the following, test once without them:
TASKWARRIOR_TUI_TASKWARRIOR_CLIuda.taskwarrior-tui.background_process- custom shortcuts or shell commands
- a heavily customized
taskrc
This helps separate a core bug from a wrapper script or environment-specific behavior.
Capture Crash Information
Section titled “Capture Crash Information”If taskwarrior-tui exits with a panic, rerun it with:
RUST_BACKTRACE=1 taskwarrior-tuiAttach the panic output together with the relevant log excerpt.
What to Include in a GitHub Issue
Section titled “What to Include in a GitHub Issue”Please include:
taskwarrior-tuiversiontaskversion- OS, terminal emulator, and shell
- whether the issue reproduces with a minimal
taskrc - whether the issue reproduces with local paths instead of mounted or network paths
- relevant log excerpts
- timings from the
time task ...comparison - exact steps to reproduce
Redact private paths, project names, or task descriptions if needed.