PHPackages                             yukabuki/term-win - 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. yukabuki/term-win

ActiveLibrary

yukabuki/term-win
=================

comprehensive low level terminal control

1.0.2(1mo ago)06↑1400%MITPHPPHP ^8.1

Since Apr 8Pushed 1mo agoCompare

[ Source](https://github.com/yukabuki/term-win)[ Packagist](https://packagist.org/packages/yukabuki/term-win)[ RSS](/packages/yukabuki-term-win/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (3)Dependencies (4)Versions (5)Used By (0)

PHP Term
========

[](#php-term)

[![CI](https://github.com/php-tui/term/actions/workflows/ci.yml/badge.svg)](https://github.com/php-tui/term/actions/workflows/ci.yml)

 [![Term Logo](https://private-user-images.githubusercontent.com/530801/286207555-ca7a8e17-2238-496d-aaa8-83c92f2f5009.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzgzMzk1NjYsIm5iZiI6MTc3ODMzOTI2NiwicGF0aCI6Ii81MzA4MDEvMjg2MjA3NTU1LWNhN2E4ZTE3LTIyMzgtNDk2ZC1hYWE4LTgzYzkyZjJmNTAwOS5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjYwNTA5JTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI2MDUwOVQxNTA3NDZaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT01NjdhODk2ZDEzNDRlYjhlNTFiMThjMTVlMDRkMmY0Y2NhMDlkOGNjYmQyZDYyYzU3N2YzOGQ1OWMxODYzMzlkJlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCZyZXNwb25zZS1jb250ZW50LXR5cGU9aW1hZ2UlMkZwbmcifQ.kXGeZa9cTdOVEf0n-9dpFronG994XomW9Y_HVyoY_-A)](https://private-user-images.githubusercontent.com/530801/286207555-ca7a8e17-2238-496d-aaa8-83c92f2f5009.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzgzMzk1NjYsIm5iZiI6MTc3ODMzOTI2NiwicGF0aCI6Ii81MzA4MDEvMjg2MjA3NTU1LWNhN2E4ZTE3LTIyMzgtNDk2ZC1hYWE4LTgzYzkyZjJmNTAwOS5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjYwNTA5JTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI2MDUwOVQxNTA3NDZaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT01NjdhODk2ZDEzNDRlYjhlNTFiMThjMTVlMDRkMmY0Y2NhMDlkOGNjYmQyZDYyYzU3N2YzOGQ1OWMxODYzMzlkJlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCZyZXNwb25zZS1jb250ZW50LXR5cGU9aW1hZ2UlMkZwbmcifQ.kXGeZa9cTdOVEf0n-9dpFronG994XomW9Y_HVyoY_-A)

This is a fork of [ALameLlama/term](https://github.com/ALameLlama/term) (which is itself a fork of [php-tui/term](https://github.com/php-tui/term)) adding native Windows support via PHP FFI.

Low-level terminal control library **heavily** inspired by [crossterm](https://github.com/crossterm-rs/crossterm).

Table of Contents
-----------------

[](#table-of-contents)

- [Installation](#installation)
- [Requirements](#requirements)
- [Usage](#usage)
    - [Actions](#actions)
    - [Events](#events)
    - [Terminal Size](#terminal-size)
    - [Raw Mode](#raw-mode)
    - [ANSI parsing](#parsing)
- [Testing](#testing)
- [Windows Support](#windows-support)
- [Contributing](#contributing)

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

[](#installation)

```
$ composer require php-tui/term

```

Requirements
------------

[](#requirements)

- PHP 8.1+
- **Linux / macOS / WSL**: `stty` must be available (standard on all POSIX systems)
- **Windows**: PHP must be compiled with the [FFI extension](https://www.php.net/manual/en/book.ffi.php) enabled (`extension=ffi`, `ffi.enable=true` in `php.ini`)

Usage
-----

[](#usage)

### Actions

[](#actions)

You can send data to the terminal using *actions*.

```