https://github.com/koddr/yatr
🏃 Yet Another Task Runner (or yatr for a short) allows you to organize and automate your routine operations that you normally do in Makefile (or else) for each project.
https://github.com/koddr/yatr
go go-tooling golang golang-application golang-tools runner task-management task-runner tools
Last synced: 8 months ago
JSON representation
🏃 Yet Another Task Runner (or yatr for a short) allows you to organize and automate your routine operations that you normally do in Makefile (or else) for each project.
- Host: GitHub
- URL: https://github.com/koddr/yatr
- Owner: koddr
- License: apache-2.0
- Created: 2023-05-30T17:40:38.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-14T11:35:57.000Z (10 months ago)
- Last Synced: 2025-04-29T19:58:28.811Z (8 months ago)
- Topics: go, go-tooling, golang, golang-application, golang-tools, runner, task-management, task-runner, tools
- Language: Go
- Homepage: https://github.com/koddr/yatr
- Size: 152 KB
- Stars: 9
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# yatr – A modern alternative to `Makefile` with a few little bells and whistles
[![Go version][go_version_img]][go_dev_url]
[![Go report][go_report_img]][go_report_url]
[![Wiki][wiki_img]][wiki_url]
[![License][license_img]][license_url]
**Y**et **A**nother **T**ask **R**unner (or `yatr` for a short) allows
you to organize and automate your routine operations that you normally do in
`Makefile` (or else) for each project.
Features:
- 100% **free** and **open source**.
- Can run any task in **async** mode (in separated goroutines).
- Supports **popular** formats of the task file (JSON, YAML, TOML, HCL).
- Has a **beautiful** appearance and **understandable** output.
## ⚡️ Quick start
First, [download][go_download] and install **Go**. Version `1.20` (or higher)
is required.
Installation is done by using the [`go install`][go_install] command:
```console
go install github.com/koddr/yatr@latest
```
> 💡 Note: See the repository's [Release page][repo_releases_url], if you want
> to download a ready-made `deb`, `rpm`, `apk` or `Arch Linux` package.
GNU/Linux and macOS users available way to install via [Homebrew][brew_url]:
```console
# Tap a new formula:
brew tap koddr/tap
# Installation:
brew install koddr/tap/yatr
```
Next, run `yatr` with `-i` option to generate initial `tasks.yml` file in the current dir:
```console
yatr -i
```
Prepare your task file in one of the supported formats: JSON
([example][json_example_file]), YAML ([example][yaml_example_file]),
TOML ([example][toml_example_file]), HCL/Terraform
([example][tf_example_file]).
> 💡 Note: See the repository's [Wiki page][wiki_url] to understand
> structure of the task file.
And now, run `yatr` with options:
```console
yatr -p ./path/to/tasks.yml
```
Done! 🎉 Your tasks have been executed.
### 🐳 Docker-way to quick start
If you don't want to physically install `yatr` to your system, you feel
free to using our [official Docker image][docker_image_url] and run it from
isolated container:
```console
docker run --rm -it -v ${PWD}:${PWD} -w ${PWD} koddr/yatr:latest [OPTIONS]
```
## 🧩 Options
| Option | Description | Is required? | Type | Default value |
|--------|----------------------------------------------------------------------------------------------|--------------|----------|---------------|
| `-i` | generate an example `tasks.yml` file in the given format | no | `bool` | `false` |
| `-p` | set a **path** to the file with tasks in any of the supporting format (see [Wiki][wiki_url]) | yes | `string` | `""` |
## 🏆 A win-win cooperation
And now, I invite you to participate in this project! Let's work **together** to
create the **most useful** tool for developers on the web today.
- [Issues][repo_issues_url]: ask questions and submit your features.
- [Pull requests][repo_pull_request_url]: send your improvements to the current.
Your PRs & issues are welcome! Thank you 😘
## ⚠️ License
[`yatr`][repo_url] is free and open-source software licensed under the
[Apache 2.0 License][license_url], created and supported with 🩵 for people and
robots by [Vic Shóstak][author].
[go_download]: https://golang.org/dl/
[go_install]: https://golang.org/cmd/go/#hdr-Compile_and_install_packages_and_dependencies
[go_version_img]: https://img.shields.io/badge/Go-1.20+-00ADD8?style=for-the-badge&logo=go
[go_report_img]: https://img.shields.io/badge/Go_report-A+-success?style=for-the-badge&logo=none
[go_report_url]: https://goreportcard.com/report/github.com/koddr/yatr
[go_code_coverage_img]: https://img.shields.io/badge/code_coverage-79%25-success?style=for-the-badge&logo=none
[go_dev_url]: https://pkg.go.dev/github.com/koddr/yatr
[docker_image_url]: https://hub.docker.com/repository/docker/koddr/yatr
[brew_url]: https://brew.sh
[wiki_img]: https://img.shields.io/badge/docs-wiki_page-blue?style=for-the-badge&logo=none
[wiki_url]: https://github.com/koddr/yatr/wiki
[wiki_tasks_file_url]: https://github.com/koddr/yatr/wiki#file-with-tasks
[json_example_file]: https://github.com/koddr/yatr/blob/main/examples/tasks.json
[yaml_example_file]: https://github.com/koddr/yatr/blob/main/examples/tasks.yaml
[toml_example_file]: https://github.com/koddr/yatr/blob/main/examples/tasks.toml
[tf_example_file]: https://github.com/koddr/yatr/blob/main/examples/tasks.tf
[license_img]: https://img.shields.io/badge/license-Apache_2.0-red?style=for-the-badge&logo=none
[license_url]: https://github.com/koddr/yatr/blob/main/LICENSE
[repo_url]: https://github.com/koddr/yatr
[repo_issues_url]: https://github.com/koddr/yatr/issues
[repo_pull_request_url]: https://github.com/koddr/yatr/pulls
[repo_releases_url]: https://github.com/koddr/yatr/releases
[author]: https://github.com/koddr