PHPackages                             kristuff/mishell - 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 &amp; Console](/categories/cli)
4. /
5. kristuff/mishell

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

kristuff/mishell
================

A mini PHP library to build beautiful CLI apps and reports

v1.6(2y ago)4782[1 issues](https://github.com/kristuff/mishell/issues)2MITPHPPHP &gt;=5.6.0

Since Apr 16Pushed 2y ago1 watchersCompare

[ Source](https://github.com/kristuff/mishell)[ Packagist](https://packagist.org/packages/kristuff/mishell)[ Docs](https://github.com/kristuff/mishell)[ RSS](/packages/kristuff-mishell/feed)WikiDiscussions master Synced 3w ago

READMEChangelog (7)DependenciesVersions (9)Used By (2)

Mishell
=======

[](#mishell)

> A mini PHP library to build beautiful CLI apps and reports

[![Build Status](https://camo.githubusercontent.com/e1d1e4575867866edcf07a8e6c4073dd6d6cc74a1a60dbc4b79e41aa9076e4bd/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f6b726973747566662f6d697368656c6c2f6261646765732f6275696c642e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/kristuff/mishell/build-status/master)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/6957f4fab357c9c7c92dc4c7a74fd37ca95928b41bd7e516b8d01a39e33810cb/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f6b726973747566662f6d697368656c6c2f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/kristuff/mishell/?branch=master)[![Latest Stable Version](https://camo.githubusercontent.com/14ad0564cdc3a74b598bc69bae81c846169f98e50aabe77b767cb827d8dbd54e/68747470733a2f2f706f7365722e707567782e6f72672f6b726973747566662f6d697368656c6c2f762f737461626c65)](https://packagist.org/packages/kristuff/mishell)[![License](https://camo.githubusercontent.com/8c8ba81720217059de114fb900bf8f7f4ebc312fec0d44c23e4561dbc275cca8/68747470733a2f2f706f7365722e707567782e6f72672f6b726973747566662f6d697368656c6c2f6c6963656e7365)](https://packagist.org/packages/kristuff/mishell)

[![sample](doc/screenshots/mishell1.6.png)](doc/screenshots/mishell1.6.png)*See also mp4 in doc/screenshots directory*

- [Features](#features)
- [Requirements](#requirements)
- [Install](#install)
- [Documentation](#documentation)
- [Run the sample](#run-the-sample)
- [License](#license)

Features
--------

[](#features)

- Printing methods:
    - Basic or colored/stylized text ✔
    - Tables ✔
    - Progress message ✔
- Get user inputs
    - standard text input ✔
    - hidden text input ✔ (no supported on Windows)
    - numeric values ✔
- Open new/restore 'window' ✔ (no supported on Windows)
- Run the bell ✔

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

[](#requirements)

- PHP &gt;= 5.6
- PHP mbstring module

Install
-------

[](#install)

Deploy with your project (in `composer.json`):

```
{
    ...
    "require": {
        "kristuff/mishell": ">=1.6-stable"
    }
}

```

> Composer is (technically) required to build autoloader files. You should be able to run the demo "as is" (with the `vendor` directory included) when you clone the project. There is no other dependencies.

Documentation
-------------

[](#documentation)

- [Project page](https://kristuff.fr/projects/mishell)
- [API documentation](https://kristuff.fr/projects/mishell/doc) *in progress...*

Run the sample
--------------

[](#run-the-sample)

[![demo](doc/screenshots/demo.gif)](doc/screenshots/demo.gif)

- clone this repo on github (*demo* and *doc* folders are excluded from dist) ```
    $ git clone https://github.com/kristuff/mishell.git
    ```
- go to mishell folder ```
    $ cd mishell
    ```
- install (it just builds autoloader, no dependencies) ```
    $ composer install
    ```
- run sample ```
    $ php demo/index.php
    ```

Bonus
-----

[](#bonus)

You can also do unuseful things like the blue screen of the death^^ Check the demo

[![blue-screen](doc/screenshots/blue-screen.png)](doc/screenshots/blue-screen.png)

Update ::1.6

[![blue-screen-1.6](doc/screenshots/blue-screen-1.5.9.png)](doc/screenshots/blue-screen-1.5.9.png)

License
-------

[](#license)

The MIT License (MIT)

Copyright (c) 2017-2024 Kristuff

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

###  Health Score

27

—

LowBetter than 47% of packages

Maintenance15

Infrequent updates — may be unmaintained

Popularity17

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity56

Maturing project, gaining track record

 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.

###  Release Activity

Cadence

Every ~228 days

Recently: every ~334 days

Total

7

Last Release

886d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/16272398?v=4)[kristuff](/maintainers/Kristuff)[@kristuff](https://github.com/kristuff)

---

Top Contributors

[![kristuff](https://avatars.githubusercontent.com/u/16272398?v=4)](https://github.com/kristuff "kristuff (38 commits)")

---

Tags

clicolorsphptablesclicolortable

### Embed Badge

![Health badge](/badges/kristuff-mishell/health.svg)

```
[![Health](https://phpackages.com/badges/kristuff-mishell/health.svg)](https://phpackages.com/packages/kristuff-mishell)
```

###  Alternatives

[kevinlebrun/colors.php

Colors for PHP CLI scripts

3426.9M45](/packages/kevinlebrun-colorsphp)[alecrabbit/php-console-spinner

Extremely flexible spinner for \[async\] php cli applications

24035.5k2](/packages/alecrabbit-php-console-spinner)[inhere/console

php console library, provide console argument parse, console controller/command run, color style, user interactive, information show.

3487.5k12](/packages/inhere-console)[alecrabbit/php-cli-snake

Lightweight cli spinner with zero dependencies

29214.4k5](/packages/alecrabbit-php-cli-snake)

PHPackages © 2026

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