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 (5 months ago)
• Default Branch: main
• Last Pushed: 2024-05-05T16:09:19.000Z (about 1 month ago)
• Last Synced: 2024-05-06T12:29:55.980Z (about 1 month ago)
• Language: Rust
• Size: 548 KB
• Stars: 9
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• 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.

![taskui-example](./taskui-example.png)

## 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.

## Installation

1. Clone the repository:

```bash

git clone https://github.com/thmshmm/taskui.git

```

2. Build the binary

```bash

cd taskui

cargo build --release

```

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.