decodelabs/systemic

Easy access to system and environment info

v0.11.16 2025-02-20 14:45 UTC

Requires

• php: ^8.4
• ext-intl: *
• decodelabs/archetype: ^0.3.8
• decodelabs/coercion: ^0.3
• decodelabs/deliverance: ^0.2.14
• decodelabs/eventful: ^0.4
• decodelabs/exceptional: ^0.5.2
• decodelabs/fluidity: ^0.3.6
• decodelabs/glitch-support: ^0.5.1
• decodelabs/veneer: ^0.12.2
• symfony/polyfill-mbstring: ^1.31

Requires (Dev)

• decodelabs/phpstan-decodelabs: ^0.7

MIT

• Tom Wright

• system
• environment

README

System processes and information at your fingertips

Systemic offers an easy to use frontend to launching and controlling processes and accessing system information.

Installation

Install via composer:

composer require decodelabs/systemic

Usage

Importing

Systemic uses Veneer to provide a unified frontage under DecodeLabs\Systemic. You can access all the primary functionality via this static frontage without compromising testing and dependency injection.

Process launching

Launch new processes:

use DecodeLabs\Systemic;

$dir = 'path/to/working-directory';

// Launch and capture output of a process
echo Systemic::capture(['ls', '-al'], $dir)->getOutput();

// Launch and capture output of a process with raw string command (not escaped)
echo Systemic::capture('ls -al', $dir)->getOutput();

// Launch and capture output of a script
echo Systemic::capture(['myPhpScript.php'], $dir)->getOutput();

// Launch a background task
$process = Systemic::launch(['make', 'install']);

// Launch a background script
$process = Systemic::launchScript(['myPhpScript.php'], $dir);

// Run a piped pseudo terminal process
$success = Systemic::run(['interactive-app', '--arg1'], $dir);

// Run a piped pseudo terminal script
$success = Systemic::runScript(['myPhpScript.php', '--arg1'], $dir);

// Custom escaped command
$success = Systemic::command(['escaped', 'arguments'])
    ->setWorkingDirectory($dir)
    ->addSignal('SIGSTOP') // Pass SIGSTOP through when caught
    ->setUser('someuser') // Attempt to use sudo to run as user
    ->run();

// Custom raw command with env arguments
$result = Systemic::command('echo ${:VARIABLE} | unescaped-command', [
        'VARIABLE' => 'Hello world'
    ])
    ->setWorkingDirectory($dir)
    ->capture();

OS info

Get information about the current OS:

use DecodeLabs\Systemic;

// OS info
echo Systemic::$os->getName(); // Linux | Windows | Darwin
echo Systemic::$os->getPlatformType(); // Unix | Windows
echo Systemic::$os->getDistribution(); // eg Ubuntu or High Sierra, etc
echo Systemic::$os->getVersion(); // System version info
echo Systemic::$os->getRelease(); // System version number
echo Systemic::$os->getHostName(); // System hostname

// Find binaries on the system
echo Systemic::$os->which('php'); // eg /usr/local/bin/php

Windows

Please note, OS and Process support on Windows is currently extremely sketchy - this will be fleshed out soon!

Locale & Timezone

Looking for Locale and Timezone info? This has moved to Cosmos.

Licensing

Systemic is licensed under the MIT License. See LICENSE for the full license text.