Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kdheepak/taskwarrior-tui
`taskwarrior-tui`: A terminal user interface for taskwarrior
https://github.com/kdheepak/taskwarrior-tui
cli rust taskwarrior tui tui-rs
Last synced: 3 days ago
JSON representation
`taskwarrior-tui`: A terminal user interface for taskwarrior
- Host: GitHub
- URL: https://github.com/kdheepak/taskwarrior-tui
- Owner: kdheepak
- License: mit
- Created: 2020-07-22T05:18:43.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-14T09:06:08.000Z (29 days ago)
- Last Synced: 2024-11-26T00:04:15.711Z (17 days ago)
- Topics: cli, rust, taskwarrior, tui, tui-rs
- Language: Rust
- Homepage: https://kdheepak.com/taskwarrior-tui
- Size: 1.77 MB
- Stars: 1,520
- Watchers: 18
- Forks: 70
- Open Issues: 93
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- my-awesome-github-stars - kdheepak/taskwarrior-tui - `taskwarrior-tui`: A terminal user interface for taskwarrior (Rust)
- awesome-ratatui - taskwarrior-tui - TUI for the Taskwarrior command-line task manager. (💻 Apps / 🚀 Productivity and Utilities)
README
# `taskwarrior-tui`
> [!IMPORTANT]
> [`taskwarrior` v3.x](https://github.com/GothenburgBitFactory/taskwarrior/releases/tag/v3.0.0) may break `taskwarrior-tui` features in unexpected ways. Please file a bug report if you encounter a bug.
[](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)
[](https://github.com/kdheepak/taskwarrior-tui/releases/latest)
A Terminal User Interface (TUI) for [Taskwarrior](https://taskwarrior.org/) 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 for more information.
Pre-compiled releases are available on the [GitHub repo](https://github.com/kdheepak/taskwarrior-tui):
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.1=~/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
- [`kdheepak`](https://github.com/sponsors/kdheepak)
- [`@GothenburgBitFactory`](https://github.com/sponsors/GothenburgBitFactory)
- and/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/tui-rs-revival/ratatui
- 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/