Skip to content

@clue clue released this Aug 28, 2019

  • Feature: Emit audible/visible BELL signal when using a disabled function.
    (#86 and #87 by @clue)

    By default, this project will emit an audible/visible BELL signal when the user
    tries to execute an otherwise disabled function, such as using the
    left or backspace keys when already at the beginning of the line.

  • Deprecated: Deprecate Readline class and move all methods to Stdio.
    (#84 by @clue)

    // deprecated:
    $stdio->getReadline()->setPrompt('> ');
    // recommended alternative:
    $stdio->setPrompt('> ');
  • Fix: Fix closing to emit final close event and clean up all listeners.
    (#88 by @clue)

  • Improve test suite to test against legacy PHP 5.3 through PHP 7.3 and support PHPUnit 7.
    (#85 by @clue)

Assets 2

@clue clue released this Sep 3, 2018 · 12 commits to master since this release

  • Feature / Fix: Accept CR as an alias for LF to support more platforms.
    (#79 by @clue)

    The enter key will usually end the line with a \n (LF)
    character on most Unix platforms. Common terminals also accept the
    ^M (CR) key in place of the ^J (LF) key.

    By now allowing CR as an alias for LF in this library, we can significantly
    improve compatibility with this common usage pattern and improve platform
    support. In particular, some platforms use different TTY settings (icrnl,
    igncr and family) and depending on these settings emit different EOL
    characters. This fixes issues where enter was not properly
    detected when using ext-readline on Mac OS X, Android and others.

  • Fix: Fix and simplify restoring TTY mode when ext-readline is not in use.
    (#74 and #78 by @clue)

  • Update project homepage, minor code style improvements and sort dependencies.
    (#72 and #81 by @clue and #75 by @localheinz)

Assets 2

@clue clue released this Feb 6, 2018 · 30 commits to master since this release

  • Feature: Add support for binding custom functions to any key code
    (#70 by @clue)

    $readline->on('?', function () use ($stdio) {
        $stdio->write('Do you need help?');
  • Feature: Add addInput() helper method
    (#69 by @clue)

    $readline->addInput(' world');
Assets 2

@clue clue released this Jan 24, 2018 · 35 commits to master since this release

A major compatibility release to update this package to support all latest
ReactPHP components!

This update involves a minor BC break due to dropped support for legacy
versions. We've tried hard to avoid BC breaks where possible and minimize impact
otherwise. We expect that most consumers of this package will actually not be
affected by any BC breaks, see below for more details.

  • BC break: Remove all deprecated APIs (individual Stdin, Stdout, line etc.)
    (#64 and #68 by @clue)

    All of this affects only what is considered "advanced usage".
    If you're affected by this BC break, then it's recommended to first
    update to the intermediary v1.2.0 release, which provides alternatives
    to all deprecated APIs and then update to this version without causing a
    BC break.

  • Feature / BC break: Consistently emit incoming "data" event with trailing newline
    unless stream ends without trailing newline (such as when piping).
    (#65 by @clue)

  • Feature: Forward compatibility with upcoming Stream v1.0 and EventLoop v1.0
    and avoid blocking when STDOUT buffer is full.
    (#68 by @clue)

Assets 2

@clue clue released this Dec 18, 2017 · 49 commits to master since this release

  • Feature: Optionally use ext-readline to enable raw input mode if available.
    This extension is entirely optional, but it is more efficient and reliable
    than spawning the external stty command.
    (#63 by @clue)

  • Feature: Consistently return boolean success from write() and
    avoid sending unneeded control codes between writes
    (#60 by @clue)

  • Deprecated: Deprecate input helpers and output helpers and
    recommend using Stdio as a normal DuplexStreamInterface instead.
    (#59 and #62 by @clue)

    // deprecated
    $stdio->on('line', function ($line) use ($stdio) {
        $stdio->writeln("input: $line");
    // recommended alternative
    $stdio->on('data', function ($line) use ($stdio) {
        $stdio->write("input: $line");
  • Improve test suite by adding forward compatibility with PHPUnit 6
    (#61 by @carusogabriel)

Assets 2

@clue clue released this Nov 1, 2017 · 65 commits to master since this release

  • Feature: Explicitly end stream on CTRL+D and emit final data on EOF without EOL
    (#56 by @clue)

  • Feature: Support running on non-TTY and closing STDIN and STDOUT streams
    (#57 by @clue)

  • Feature / Fix: Restore blocking mode before closing and restore TTY mode on unclean shutdown
    (#58 by @clue)

  • Improve documentation to detail why async console I/O is not supported on Microsoft Windows
    (#54 by @clue)

  • Improve test suite by adding PHPUnit to require-dev,
    fix HHVM build for now again and ignore future HHVM build errors and
    lock Travis distro so future defaults will not break the build
    (#46, #48 and #52 by @clue)

Assets 2

@clue clue released this Jan 8, 2017 · 91 commits to master since this release

  • First stable release, now following SemVer

Contains no other changes, so it's actually fully compatible with the v0.5.0 release.

Assets 2

@clue clue released this Jan 8, 2017 · 92 commits to master since this release

  • Feature: Add history support
    (#40 by @clue)
  • Feature: Add autocomplete support
    (#41 by @clue)
  • Feature: Suggest using ext-mbstring, otherwise use regex fallback
    (#42 by @clue)
  • Remove / BC break: Remove undocumented and low quality skeletons/helpers for
    Buffer, ProgressBar and Spinner (mostly dead code)
    (#39, #43 by @clue)
  • First class support for PHP 5.3 through PHP 7 and HHVM
    (#44 by @clue)
  • Simplify and restructure examples
    (#45 by @clue)
Assets 2

@clue clue released this Sep 27, 2016 · 124 commits to master since this release

  • Feature / BC break: The Stdio is now a well-behaving duplex stream
    (#35 by @clue)
  • Feature / BC break: The Readline is now a well-behaving readable stream
    (#32 by @clue)
  • Feature: Add Readline::getPrompt() helper
    (#33 by @clue)
  • Feature / Fix: All unsupported special keys, key codes and byte sequences will now be ignored
    (#36, #30, #19, #38 by @clue)
  • Fix: Explicitly redraw prompt on empty input
    (#37 by @clue)
  • Fix: Writing data that contains multiple newlines will no longer end up garbled
    (#34, #35 by @clue)
Assets 2

@clue clue released this Nov 26, 2015 · 149 commits to master since this release

  • Fix: Support calling Readline::setInput() during line event
$stdio->on('line', function ($line) use ($stdio) {
    $stdio->getReadline()->setInput($line . '!');
Assets 2
You can’t perform that action at this time.