TaskUI is a lightweight terminal user interface for executing tasks defined using taskfile.dev. It provides an easy way to navigate through tasks using arrow keys or Vim-like shortcuts.
Current features are task execution, search and preview.
- Navigate through tasks using arrow keys
upanddown, or usejandkto move. - Press
Enterto execute the selected task. - Press
qto exit the program without executing a task. - Press
/to toggle the search bar. UseEscto reset the search orEnterto get back to selection mode. - Press
pto toggle the preview of a selected task. Usepagain orqto close the preview.
TaskUI can be configured using environment variables.
Available configuration options are:
| Environment Variable | Description | Default |
|---|---|---|
TASKUI_LIST_INTERNAL |
Show internal tasks in the task list | false |
TASKUI_HIGHLIGHT_STYLE_BG |
Background color for highlighted task | #ffffff |
TASKUI_HIGHLIGHT_STYLE_FG |
Foreground/text color for highlighted task | #4c4f69 |
- Clone the repository:
git clone https://github.com/thmshmm/taskui.git
- Build the binary
using cargo:
cd taskui
cargo build --releaseusing Nix:
nix build
- Create a shell alias for easy access:
alias tui="/path/to/taskui"
version: '3' includes: k8s: ./k8s.yml docker: ./docker # requires ./docker/Taskfile.yml to exits helm: taskfile: ./helm.yml optional: true tasks: uptime: cmds: - uptime date: cmds: - date
If you have any suggestions, improvements, or bug fixes, feel free to open an issue or submit a pull request.