README

Terminal Detector

Detects which terminal emulator is running the current PHP process.

Requires PHP 8.2+

Installation

composer require shipfastlabs/terminal-detector

Usage

use TerminalDetector\TerminalDetector;

$result = TerminalDetector::detect();

if ($result->detected) {
    echo "Running inside: {$result->name}";
}

// Check for a specific known terminal
if ($result->knownTerminal() === \TerminalDetector\KnownTerminal::Ghostty) {
    echo "Hello from Ghostty!";
}

Or use the standalone function:

use function TerminalDetector\detectTerminal;

$result = detectTerminal();

Result Properties

$result->detected;        // true / false
$result->name;            // e.g. 'iterm2', 'ghostty', 'vscode'
$result->version;         // e.g. '3.5.0' (from TERM_PROGRAM_VERSION)
$result->knownTerminal(); // KnownTerminal enum or null

Known Terminals

The KnownTerminal enum provides type-safe identifiers for all supported terminals:

Supported Terminals

Custom Override

Set the TERMINAL_DETECTOR environment variable to force a specific terminal name:

TERMINAL_DETECTOR=my-terminal php script.php

License

Terminal Detector is open-sourced software licensed under the MIT license.