PHPackages                             recipe-runner/io-module - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. recipe-runner/io-module

ActiveLibrary

recipe-runner/io-module
=======================

IO module for Recipe Runner

026PHP

Since Jul 19Pushed 6y ago1 watchersCompare

[ Source](https://github.com/recipe-runner/io-module)[ Packagist](https://packagist.org/packages/recipe-runner/io-module)[ RSS](/packages/recipe-runner-io-module/feed)WikiDiscussions master Synced today

READMEChangelogDependenciesVersions (1)Used By (0)

IO module
=========

[](#io-module)

[![Latest Version on Packagist](https://camo.githubusercontent.com/67f4ad0eca139201f1777d245601ee1db188814901cbd47ad5f57c96dc9a3bba/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f7265636970652d72756e6e65722f696f2d6d6f64756c652e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/recipe-runner/io-module)[![Build Status](https://camo.githubusercontent.com/e996b321c5f108960c1384d0b06033a1156393416311c6f1b7e358ee89c60ee9/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f7265636970652d72756e6e65722f696f2d6d6f64756c652f6d61737465722e7376673f7374796c653d666c61742d737175617265)](https://travis-ci.org/recipe-runner/io-module)

Input/output operations such as `write` or `ask` for interacting with the user.

Requires
--------

[](#requires)

- PHP +7.2
- [Recipe Runner](https://github.com/recipe-runner/recipe-runner)

Installation
------------

[](#installation)

Create a recipe and add the module to the `packages` section:

```
name: "Your recipe"
extra:
  rr:
    packages:
      "recipe-runner/io-module": "1.0.x-dev"
```

Usage
-----

[](#usage)

### Method: `write`

[](#method-write)

Write a message to the output.

```
steps:
    - actions:
        - write: "Hi user. Welcome back."
```

Messages with several lines are allowed:

```
steps:
    - actions:
        - write:
            "Hi user"
            "Welcome :)"
```

### Method: `ask`

[](#method-ask)

Ask a question to the user.

```
steps:
    - actions:
        - ask: "What's your name?"
          register: "question1"
        - write: "The Response was: '{{question1['response']}}'"
```

Default value for a question is empty string. Set a custom default value is possible:

```
ask:
  question: "What's your name?"
  default: "Jack"
```

Response:

```
{
  "response": "bla bla"
}
```

### Method `ask_yes_no`

[](#method-ask_yes_no)

Ask a yes/no question to the user. Values accepted as response:

- `true`: true, "true", "yes", "1", 1
- `false`: false, "false", "no", "0", 0

Default value: `true`.

```
ask_yes_no: "Are you sure?"
```

or

```
ask_yes_no:
  question: "What's your name?"
  default: true
```

Response:

```
{
  "response": true
}
```

For module developers
---------------------

[](#for-module-developers)

The preferred installation method is [composer](https://getcomposer.org):

```
composer require recipe-runner/io-module
```

### Unit tests

[](#unit-tests)

You can run the unit tests with the following command:

```
$ cd io-module
$ composer test
```

License
-------

[](#license)

This library is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).

###  Health Score

19

—

LowBetter than 10% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity36

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/cac3ac1311a4a66c37c1c6cb3301e6a02e5f4f8b742dfb95d1ce6805e8d8fe94?d=identicon)[yosymfony](/maintainers/yosymfony)

---

Top Contributors

[![yosymfony](https://avatars.githubusercontent.com/u/3321099?v=4)](https://github.com/yosymfony "yosymfony (6 commits)")

---

Tags

modulephprecipe-runner

### Embed Badge

![Health badge](/badges/recipe-runner-io-module/health.svg)

```
[![Health](https://phpackages.com/badges/recipe-runner-io-module/health.svg)](https://phpackages.com/packages/recipe-runner-io-module)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)