Skip to content

recipe-runner/rr-cli

Repository files navigation

RR - Recipe Runner CLI tool

Build Status

Requires

  • PHP +7.3
  • Composer +1.9

Installation

The preferred installation method is composer:

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:
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']}}'"
  1. Run the recipe:
./bin/rr run example.rr.yml

Unit tests

You can run the unit tests with the following command:

$ cd rr-cli
$ composer test

License

This library is open-sourced software licensed under the MIT license.