mirror of
https://github.com/kdheepak/taskwarrior-tui.git
synced 2025-08-24 23:46:41 +02:00
Update docs
This commit is contained in:
Dheepak Krishnamurthy
parent
ea458db64c
commit
420a29c5df
10 changed files with 293 additions and 265 deletions
266
README.md
266
README.md
|
|
@ -11,268 +11,4 @@ A Terminal User Interface for [Taskwarrior](https://taskwarrior.org/).
|
|||
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
Unless otherwise specified, 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) [](https://formulae.brew.sh/formula/taskwarrior-tui)
|
||||
|
||||
|
||||
This installs `task` from `homebrew` as well.
|
||||
|
||||
```bash
|
||||
brew install taskwarrior-tui
|
||||
```
|
||||
|
||||
**Installation for Arch Linux** [](https://archlinux.org/packages/community/x86_64/taskwarrior-tui/) [](https://aur.archlinux.org/packages/taskwarrior-tui-git/)
|
||||
|
||||
Use [pacman](https://wiki.archlinux.org/index.php/Pacman) to install it from the [community repository](https://archlinux.org/packages/community/x86_64/taskwarrior-tui/):
|
||||
|
||||
```bash
|
||||
pacman -S taskwarrior-tui
|
||||
```
|
||||
|
||||
Or use your favorite [AUR helper](https://wiki.archlinux.org/index.php/AUR_helpers) to download the [git](https://aur.archlinux.org/packages/taskwarrior-tui-git/) package maintained by [**@loki7990**](https://github.com/loki7990). For example:
|
||||
|
||||
```bash
|
||||
yay -S taskwarrior-tui-git # build from source master
|
||||
```
|
||||
|
||||
**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
|
||||
|
||||
_Tip_: Alias `tt` to `taskwarrior-tui`.
|
||||
|
||||
Add the following to your dotfiles (e.g. `~/.bashrc`, `~/.zshrc`):
|
||||
|
||||
```
|
||||
alias tt="taskwarrior-tui"
|
||||
```
|
||||
|
||||
### 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>
|
||||
|
||||
### Context switcher:
|
||||
|
||||
<details>
|
||||
|
||||
<summary> Click to expand! </summary>
|
||||
|
||||
|
||||
|
||||
</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-info=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
|
||||
```
|
||||
|
||||
And here are the default key bindings:
|
||||
|
||||
```plaintext
|
||||
uda.taskwarrior-tui.keyconfig.quit=q
|
||||
uda.taskwarrior-tui.keyconfig.refresh=r
|
||||
uda.taskwarrior-tui.keyconfig.go-to-bottom=G
|
||||
uda.taskwarrior-tui.keyconfig.go-to-top=g
|
||||
uda.taskwarrior-tui.keyconfig.down=j
|
||||
uda.taskwarrior-tui.keyconfig.up=k
|
||||
uda.taskwarrior-tui.keyconfig.page-down=J
|
||||
uda.taskwarrior-tui.keyconfig.page-up=K
|
||||
uda.taskwarrior-tui.keyconfig.delete=x
|
||||
uda.taskwarrior-tui.keyconfig.done=d
|
||||
uda.taskwarrior-tui.keyconfig.start-stop=s
|
||||
uda.taskwarrior-tui.keyconfig.undo=u
|
||||
uda.taskwarrior-tui.keyconfig.edit=e
|
||||
uda.taskwarrior-tui.keyconfig.modify=m
|
||||
uda.taskwarrior-tui.keyconfig.shell=!
|
||||
uda.taskwarrior-tui.keyconfig.log=l
|
||||
uda.taskwarrior-tui.keyconfig.add=a
|
||||
uda.taskwarrior-tui.keyconfig.annotate=A
|
||||
uda.taskwarrior-tui.keyconfig.filter=/
|
||||
uda.taskwarrior-tui.keyconfig.zoom=z
|
||||
uda.taskwarrior-tui.keyconfig.context-menu=c
|
||||
uda.taskwarrior-tui.keyconfig.next-tab=]
|
||||
uda.taskwarrior-tui.keyconfig.previous-tab=[
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
#### Configure user defined shortcuts:
|
||||
|
||||
<details>
|
||||
|
||||
<summary> Click to expand! </summary>
|
||||
|
||||
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:
|
||||
|
||||
```plaintext
|
||||
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:
|
||||
|
||||
```bash
|
||||
~/.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` :
|
||||
|
||||
```plaintext
|
||||
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:
|
||||
|
||||
```plaintext
|
||||
uda.taskwarrior-tui.keyconfig.shortcut1=n
|
||||
```
|
||||
|
||||
You can set up shortcuts to run `task sync` or any custom bash script that you'd like.
|
||||
|
||||
</details>
|
||||
|
||||
# Related
|
||||
|
||||
For a similar effort, check out `vit`:
|
||||
|
||||
- `vit`: <https://github.com/vit-project/vit>
|
||||
See <https://kdheepak.com/taskwarrior-tui> for documentation.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue