PHPackages                             php-school/cli-menu - 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. [CLI & Console](/categories/cli)
4. /
5. php-school/cli-menu

ActiveLibrary[CLI & Console](/categories/cli)

php-school/cli-menu
===================

A command line menu helper in PHP

4.4.0(11mo ago)1.9k1.2M↓40.6%107[7 issues](https://github.com/php-school/cli-menu/issues)[1 PRs](https://github.com/php-school/cli-menu/pulls)20MITPHPPHP >=8.2CI failing

Since Oct 19Pushed 10mo ago43 watchersCompare

[ Source](https://github.com/php-school/cli-menu)[ Packagist](https://packagist.org/packages/php-school/cli-menu)[ RSS](/packages/php-school-cli-menu/feed)WikiDiscussions master Synced 3d ago

READMEChangelog (10)Dependencies (5)Versions (25)Used By (20)

 [![](https://cloud.githubusercontent.com/assets/2174476/10601666/071e3e24-770b-11e5-9cba-8ae6402ff550.gif)](https://cloud.githubusercontent.com/assets/2174476/10601666/071e3e24-770b-11e5-9cba-8ae6402ff550.gif)

 [ ![](https://camo.githubusercontent.com/2f5c221e0a83735ded25e1f1c1e0bd1a05950d70bda3a866981048b7ffe163e3/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f7068702d7363686f6f6c2f636c692d6d656e752f746573742e796d6c3f7374796c653d666c61742d737175617265266c6162656c3d4c696e7578) ](https://github.com/php-school/cli-menu/actions "Build Status") [ ![](https://camo.githubusercontent.com/d24862eb76a673f08ec89e1f6d3d538499a26008385c9077f606671b73c62070/68747470733a2f2f696d672e736869656c64732e696f2f6170707665796f722f63692f6d696b65796d696b652f636c692d6d656e752f6d61737465722e7376673f7374796c653d666c61742d737175617265266c6162656c3d57696e646f7773) ](https://ci.appveyor.com/project/mikeymike/cli-menu "Windows Build Status") [ ![](https://camo.githubusercontent.com/b222814a64a4d73ada1d5b9dc073b0b8b6230a1ae0dd908c8642e449e610516e/68747470733a2f2f696d672e736869656c64732e696f2f636f6465636f762f632f6769746875622f7068702d7363686f6f6c2f636c692d6d656e752e7376673f7374796c653d666c61742d737175617265) ](https://codecov.io/github/php-school/cli-menu "Coverage Status") [ ![](https://camo.githubusercontent.com/d05386ae61e7749b28cd7ffb30572967157470b80d6a162535adb6a58848e4d6/68747470733a2f2f696d672e736869656c64732e696f2f7363727574696e697a65722f672f7068702d7363686f6f6c2f636c692d6d656e752e7376673f7374796c653d666c61742d737175617265) ](https://scrutinizer-ci.com/g/php-school/cli-menu/ "Scrutinizer Code Quality") [ ![](https://camo.githubusercontent.com/8124c34f475098621222ba23aae5f0025cac4d4ce881c71883cffef42f3d5faa/68747470733a2f2f7068707363686f6f6c2e6865726f6b756170702e636f6d2f62616467652e737667) ](https://phpschool-team.slack.com/messages)

---

Contents
--------

[](#contents)

- [Minimum Requirements](#minimum-requirements)
- [Installation](#installation)
- [Upgrading](#upgrading)
- [Usage](#usage)
    - [Quick Setup](#quick-setup)
    - [Examples](#examples)
- [API](#api)
    - [Appearance](#appearance)
        - [Menu Title](#menu-title)
        - [Colour](#colour)
        - [Width](#width)
        - [Padding](#padding)
        - [Margin](#margin)
        - [Borders](#borders)
        - [Exit Button Text](#exit-button-text)
        - [Remove Exit Button](#remove-exit-button)
    - [Items](#items)
        - [Selectable Item](#selectable-item)
        - [Checkbox Item](#checkbox-item)
        - [Radio Item](#radio-item)
        - [Line Break Item](#line-break-item)
        - [Static Item](#static-item)
        - [Ascii Art Item](#ascii-art-item)
        - [Sub Menu Item](#sub-menu-item)
        - [Split Item](#split-item)
    - [Disabling Items & Sub Menus](#disabling-items--sub-menus)
    - [Item Markers](#item-markers)
    - [Item Extra](#item-extra)
    - [Menu Methods](#menu-methods)
        - [Redrawing the Menu](#redrawing-the-menu)
        - [Getting, Removing and Adding items](#getting-removing-and-adding-items)
    - [Custom Control Mapping](#custom-control-mapping)
    - [Item Keyboard Shortcuts](#item-keyboard-shortcuts)
    - [Dialogues](#dialogues)
        - [Flash](#flash)
        - [Confirm](#confirm)
    - [Inputs](#inputs)
        - [Text](#text-input)
        - [Number](#number-input)
        - [Password](#password-input)
        - [Custom Input](#custom-input)
    - [Dialogues & Input Styling](#dialogues--input-styling)
- [Docs Translations](#docs-translations)
- [Integrations](#integrations)

Minimum Requirements
--------------------

[](#minimum-requirements)

- PHP 7.1
- Composer
- ext-posix

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

[](#installation)

```
composer require php-school/cli-menu
```

Upgrading
---------

[](#upgrading)

Please refer to the [Upgrade Documentation](UPGRADE.md) documentation to see what is required to upgrade your installed `cli-menu` version.

Usage
-----

[](#usage)

### Quick Setup

[](#quick-setup)

Here is a super basic example menu which will echo out the text of the selected item to get you started.

```