Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thmshmm/taskui
TaskUI is a lightweight terminal user interface for executing tasks defined using taskfile.dev.
https://github.com/thmshmm/taskui
Last synced: about 1 month ago
JSON representation
TaskUI is a lightweight terminal user interface for executing tasks defined using taskfile.dev.
- Host: GitHub
- URL: https://github.com/thmshmm/taskui
- Owner: thmshmm
- License: mit
- Created: 2024-01-23T17:31:21.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-08-11T13:49:03.000Z (4 months ago)
- Last Synced: 2024-08-11T15:01:10.027Z (4 months ago)
- Language: Rust
- Size: 551 KB
- Stars: 16
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ratatui - TaskUI - Simple Terminal UI for Task / taskfile.dev. (💻 Apps / ⌨️ Development Tools)
README
# TaskUI - Simple Terminal UI for Task / taskfile.dev
TaskUI is a lightweight terminal user interface for executing tasks defined using [taskfile.dev](https://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`.
## Usage
- Navigate through tasks using arrow keys `up` and `down`, or use `j` and `k` to move.
- Press `Enter` to execute the selected task.
- Press `q` to exit the program without executing a task.
- Press `/` to toggle the search bar. Use `Esc` to reset the search or `Enter` to get back to selection mode.
- Press `p` to toggle the preview of a selected task. Use `p` again or `q` to close the preview.
## Configuration
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` |
## Installation
1. Clone the repository:
```bash
git clone https://github.com/thmshmm/taskui.git
```
2. Build the binary
using cargo:
```bash
cd taskui
cargo build --release
```
using Nix:
```bash
nix build
```
3. Create a shell alias for easy access:
```bash
alias tui="/path/to/taskui"
```
## Example Taskfile.yml
```yaml
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
```
## Contributing
If you have any suggestions, improvements, or bug fixes, feel free to open an issue or submit a pull request.