This package is abandoned and no longer maintained. No replacement package was suggested.

free as in freedom php component to easy up usage of php readline implementation in php 5.3 and above

1.2.2 2017-05-05 20:32 UTC

This package is auto-updated.

Last update: 2021-03-05 12:35:21 UTC


I still like the idea but there is currently no use case to develop it anymore.

Readline Component for PHP

This project aims to deliver an easy to use and free as in freedom php compontent for dealing with unix console readline and autocomplete php scripts.

The build status of the current master branch is tracked by Travis CI: Build Status Latest stable

The scrutinizer status are: code quality | build status

The versioneye status is: Dependency Status

Take a look on

The current change log can be found here.


  • autocomplete support
  • readline support
  • configuration as array
    • set array with possible autocomplete options
    • bind actions to specific autocomplete options
    • supports function, closures and objects as autocomplete target
  • easy up php's readline implementation as seen here
  • works with PHP 5.3 and above


use Net\Bazzline\Component\Cli\Readline\ManagerFactory;

require_once __DIR__ . '/../vendor/autoload.php';

$factory    = new ManagerFactory();
$manager    = $factory->create();
$myClass    = new MyClass();    //assuming a class "MyClass" exists

        'git' => array(
            'add' => function ($files) {
                if (!is_null($files)) {
                    passthru('/usr/bin/env git add ' . implode(' ', $files));
            'commit' => function ($message) {
                if (is_null($message)) {
                    passthru('/usr/bin/env git commit');
                } else {
                    passthru('/usr/bin/env git commit -m "' . (string) $message . '"');
        'info' => 'phpinfo',
        'my' => array(
            'function_one' => array($myClass, 'one'),   //assuming MyClass has a method "one"
            'function_two' => array($myClass, 'two')    //assuming MyClass has a method "two"
$manager->setPrompt(': ');

The example above would result into the following possible autocompletion cases.

  • no word
    • git
    • info
    • my
  • first word is git
    • add
    • commit
  • first word is my
    • function_one
    • function_two


By Hand

mkdir -p vendor/net_bazzline/php_component_cli_readline
cd vendor/net_bazzline/php_component_cli_readline
git clone .

With Packagist

composer require net_bazzline/php_component_cli_readline:dev-master


API is available at

Other Great Components

Final Words

Star it if you like it :-). Add issues if you need it. Pull patches if you enjoy it. Write a blog entry if you use it :-D.