https://github.com/eagomez2/recp
A tool for automating command line recipes.
https://github.com/eagomez2/recp
automation bash cli pipelines terminal
Last synced: 5 months ago
JSON representation
A tool for automating command line recipes.
- Host: GitHub
- URL: https://github.com/eagomez2/recp
- Owner: eagomez2
- License: cc-by-sa-4.0
- Created: 2026-01-04T00:15:57.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2026-01-10T22:04:40.000Z (6 months ago)
- Last Synced: 2026-01-11T06:39:18.807Z (6 months ago)
- Topics: automation, bash, cli, pipelines, terminal
- Language: Python
- Homepage: https://eagomez2.github.io/recp/
- Size: 712 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `recp` A tool for automating command line recipes
`recp` (short for recipe) is a tool designed to automate processes that involve executing multiple sequential command-line steps. A recipe is defined in a `.yaml` file, which outlines the steps to be performed. Each step can include a tags, description, a set of environment variables to be set for that step, and one or more commands to be executed. Additionally, commands can be preprocessed, allowing a single instruction to be expanded into multiple commands, thereby eliminating the need for tedious repeated and error-prone manual steps or scripts lacking flexibility.
A single recipe `.yaml` file can define multiple steps, which can be selected or filtered based on the task at hand. This flexibility allows you to execute only a subset of a larger recipe when needed. The `--dry-run` option enables generating the commands without actually running them, allowing you to verify that everything works as expected before executing time-consuming processes.
# Installation
You can directly install it using `pip`
```bash
pip install recp
```
or with `uv`
```bash
uv tool install recp
```
# Quickstart
Check the quickstart guide [here](https://eagomez2.github.io/recp/).
# Documentation
The `recp` documentation is available online [here](https://eagomez2.github.io/recp/). You can also view it locally by running:
```bash
mkdocs serve
```
# Cite
If this package contributed to your work, please consider citing it:
```
@misc{recp,
author = {Esteban Gómez},
title = {recp},
year = 2026,
url = {https://github.com/eagomez2/recp}
}
```
# License
For further details about the license of this package, please see [LICENSE](LICENSE).