Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/decodelabs/systemic
Reusable PHP system info all in one place
https://github.com/decodelabs/systemic
locale php process system
Last synced: 16 days ago
JSON representation
Reusable PHP system info all in one place
- Host: GitHub
- URL: https://github.com/decodelabs/systemic
- Owner: decodelabs
- License: mit
- Created: 2019-09-26T09:31:06.000Z (over 5 years ago)
- Default Branch: develop
- Last Pushed: 2024-09-04T21:34:12.000Z (5 months ago)
- Last Synced: 2024-11-22T16:46:54.746Z (2 months ago)
- Topics: locale, php, process, system
- Language: PHP
- Homepage:
- Size: 272 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Systemic
[](https://packagist.org/packages/decodelabs/systemic)
[](https://packagist.org/packages/decodelabs/systemic)
[](https://packagist.org/packages/decodelabs/systemic)
[](https://github.com/decodelabs/systemic/actions/workflows/integrate.yml)
[](https://github.com/phpstan/phpstan)
[](https://packagist.org/packages/decodelabs/systemic)
### System processes and information at your fingertips
Systemic offers an easy to use frontend to launching and controlling processes and accessing system information.
_Get news and updates on the [DecodeLabs blog](https://blog.decodelabs.com)._
---
## Installation
Install via composer:
```bash
composer require decodelabs/systemic
```
## Usage
### Importing
Systemic uses [Veneer](https://github.com/decodelabs/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:
```php
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:
```php
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](https://github.com/decodelabs/cosmos).
## Licensing
Systemic is licensed under the MIT License. See [LICENSE](./LICENSE) for the full license text.