https://github.com/recipe-runner/rr-cli
Command line tool for the Recipe Runner
https://github.com/recipe-runner/rr-cli
automation php recipe-runner yaml
Last synced: 2 months ago
JSON representation
Command line tool for the Recipe Runner
- Host: GitHub
- URL: https://github.com/recipe-runner/rr-cli
- Owner: recipe-runner
- License: mit
- Created: 2019-05-03T23:21:46.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-11-16T23:13:29.000Z (over 6 years ago)
- Last Synced: 2025-10-25T11:33:48.546Z (8 months ago)
- Topics: automation, php, recipe-runner, yaml
- Language: PHP
- Homepage:
- Size: 132 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# RR - Recipe Runner CLI tool
[](https://travis-ci.org/recipe-runner/rr-cli)
## Requires
* PHP +7.3
* Composer +1.9
## Installation
The preferred installation method is [composer](https://getcomposer.org):
```bash
composer require recipe-runner/rr-cli
```
## Usage
Inside the folder `./bin`, there is an executable file called `rr`
```
./bin/rr
```
### Run your first recipe
1. Copy the following YAML code into a file called `example.rr.yml`:
```yaml
name: "Very simple example using IO module"
extra:
rr:
packages:
"recipe-runner/io-module": "1.0.x-dev"
steps:
- actions:
- name: "Greeting"
write: "Hi user. Welcome :)"
- ask: "How are you? "
register: "response"
- write: "The Response was: '{{response['response']}}'"
```
2. Run the recipe:
```
./bin/rr run example.rr.yml
```
## Unit tests
You can run the unit tests with the following command:
```bash
$ cd rr-cli
$ composer test
```
## License
This library is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).