mirror of
https://github.com/kdheepak/taskwarrior-tui.git
synced 2025-08-25 08:47:18 +02:00
178 lines
6.5 KiB
Markdown
178 lines
6.5 KiB
Markdown
# `taskwarrior-tui`
|
|
|
|
[](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)
|
|
|
|
A Terminal User Interface for [Taskwarrior](https://taskwarrior.org/).
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
You will need to install `taskwarrior` first. See <https://taskwarrior.org/download/> for more information.
|
|
|
|
**Manual** ( _Recommended_ ) [](https://github.com/kdheepak/taskwarrior-tui/releases/latest) [](https://github.com/kdheepak/taskwarrior-tui/releases/latest)
|
|
|
|
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`.
|
|
|
|
**Install from source** [](https://github.com/kdheepak/taskwarrior-tui)
|
|
|
|
```bash
|
|
git clone https://github.com/kdheepak/taskwarrior-tui.git
|
|
cd taskwarrior-tui
|
|
cargo build --release
|
|
```
|
|
|
|
**Using [`brew`](https://brew.sh/)** [](https://formulae.brew.sh/formula/taskwarrior-tui)
|
|
|
|
This installs `task` from `homebrew` as well.
|
|
|
|
```bash
|
|
brew install taskwarrior-tui
|
|
```
|
|
|
|
**Install from [`AUR`](https://wiki.archlinux.org/index.php/Arch_User_Repository)** [](https://aur.archlinux.org/packages/taskwarrior-tui-git/) [](https://aur.archlinux.org/packages/taskwarrior-tui/) [](https://aur.archlinux.org/packages/taskwarrior-tui-bin/)
|
|
|
|
Use your favorite installation method to download from the [AUR git](https://aur.archlinux.org/packages/taskwarrior-tui-git/) maintained by [**@loki7990**](https://github.com/loki7990). For example:
|
|
|
|
```bash
|
|
yay -S taskwarrior-tui-git # build from source master
|
|
```
|
|
|
|
Or use your favorite installation method to download from the [AUR latest release](https://aur.archlinux.org/packages/taskwarrior-tui/) or the [AUR precompiled binaries](https://aur.archlinux.org/packages/taskwarrior-tui/) maintained by [**@orhun**](https://github.com/orhun). For example:
|
|
|
|
```bash
|
|
yay -S taskwarrior-tui # build from source latest release
|
|
# Or
|
|
yay -S taskwarrior-tui-bin # download precompiled binaries
|
|
```
|
|
|
|
**Using [`snap`](https://snapcraft.io/)** [](https://snapcraft.io/taskwarrior-tui)
|
|
|
|
```bash
|
|
snap install taskwarrior-tui
|
|
```
|
|
|
|
**Using [`cargo`](https://crates.io/)** [](https://libraries.io/cargo/taskwarrior-tui)
|
|
|
|
```bash
|
|
cargo install taskwarrior-tui
|
|
```
|
|
|
|
**Using [`zdharma/zinit`](https://github.com/zdharma/zinit)** [](https://github.com/kdheepak/taskwarrior-tui/releases/latest)
|
|
|
|
Add the following to your `~/.zshrc`:
|
|
|
|
```zsh
|
|
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:
|
|
|
|
<details>
|
|
|
|
<summary> Click to expand! </summary>
|
|
|
|
|
|
|
|
</details>
|
|
|
|
### Easy to use interface:
|
|
|
|
<details>
|
|
|
|
<summary> Click to expand! </summary>
|
|
|
|
See [KEYBINDINGS.md](./KEYBINDINGS.md) for full list.
|
|
|
|
|
|
|
|
</details>
|
|
|
|
### `readline`-like functionality:
|
|
|
|
<details>
|
|
|
|
<summary> Click to expand! </summary>
|
|
|
|
- `<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
|
|
|
|
|
|
|
|
</details>
|
|
|
|
### Calendar view
|
|
|
|
<details>
|
|
|
|
<summary> Click to expand! </summary>
|
|
|
|
`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.
|
|
|
|
</details>
|
|
|
|
### Configure `taskwarrior-tui` using `~/.taskrc`:
|
|
|
|
<details>
|
|
|
|
<summary> Click to expand! </summary>
|
|
|
|
`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:
|
|
|
|
```plaintext
|
|
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.
|
|
|
|
```plaintext
|
|
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
|
|
```
|
|
|
|
</details>
|