PHPackages                             cli/terminal - 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. cli/terminal

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

cli/terminal
============

MC-Style PHP Console Application

0.1.0(7mo ago)379[4 issues](https://github.com/php-cli/terminal/issues)MITPHPPHP >=8.3CI passing

Since Oct 10Pushed 3mo ago1 watchersCompare

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

READMEChangelog (1)Dependencies (9)Versions (3)Used By (0)

Commander - MC-Style PHP Console Application
============================================

[](#commander---mc-style-php-console-application)

 **Component-based Midnight Commander-style terminal application framework.**
 Create fullscreen, keyboard-driven interfaces with double-buffered rendering.

---

Why Commander?
--------------

[](#why-commander)

Build terminal UIs like you build web apps - with reusable components, clean architecture, and modern PHP.

```
use Butschster\Commander\SDK\Builder\ApplicationBuilder;
use Butschster\Commander\Module\FileBrowser\FileBrowserModule;

$app = ApplicationBuilder::create()
    ->withModule(new FileBrowserModule())
    ->withInitialScreen('file_browser')
    ->build();

$app->run();
```

**No complex setup. No learning curve. Just beautiful terminal UIs.**

---

Features
--------

[](#features)

- **Multiple Color Themes** - Midnight Commander, Dark, and Light themes
- **Double-Buffered Rendering** - Flicker-free display with minimal ANSI sequences
- **Component-Based Architecture** - Reusable UI components (Tables, Forms, Lists, Panels)
- **Module SDK** - Extensible plugin system for adding new features
- **Full Keyboard Navigation** - Function keys, arrow keys, and shortcuts
- **Built-in Modules** - File Browser, Command Browser, Composer Manager, Git

---

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

[](#requirements)

- PHP 8.3 or higher
- Symfony Console 7.3+
- Terminal with ANSI color support

---

Quick Start
-----------

[](#quick-start)

### 1. Installation

[](#1-installation)

```
composer require cli/terminal
```

### 2. Create Launch Script

[](#2-create-launch-script)

Create a PHP file (e.g., `console`) that launches the Commander interface:

```
#!/usr/bin/env php