chore: extract console

Author: loks0n

README.md

@@ -1,160 +1,79 @@
-# Utopia CLI
+# Utopia Console
 
-[![Build Status](https://travis-ci.org/utopia-php/cli.svg?branch=master)](https://travis-ci.com/utopia-php/cli)
-![Total Downloads](https://img.shields.io/packagist/dt/utopia-php/cli.svg)
-[![Discord](https://img.shields.io/discord/564160730845151244)](https://appwrite.io/discord)
+Small collection of helpers for working with PHP command line applications. The Console class focuses on everyday needs such as logging, prompting users for input, executing external commands, and building long-running daemons.
 
-Utopia framework CLI library is simple and lite library for extending Utopia PHP Framework to be able to code command line applications. This library is aiming to be as simple and easy to learn and use. This library is maintained by the [Appwrite team](https://appwrite.io).
+## Installation
 
-Although this library is part of the [Utopia Framework](https://github.com/utopia-php/framework) project it is dependency free and can be used as standalone with any other PHP project or framework.
+Install using Composer:
 
-## Getting Started
-
-Install using composer:
 ```bash
-composer require utopia-php/cli
+composer require utopia-php/console
 ```
 
-script.php
+## Usage
+
 ```php
 <?php
-require_once './vendor/autoload.php';
-
-use Utopia\CLI\CLI;
-use Utopia\CLI\Console;
-use Utopia\CLI\Adapters\Generic;
-use Utopia\Http\Validator\Wildcard;
-
-$cli = new CLI(new Generic());
+require_once __DIR__.'/vendor/autoload.php';
 
-$cli
-    ->task('command-name')
-    ->param('email', null, new Wildcard())
-    ->action(function ($email) {
-        Console::success($email);
-    });
-
-$cli->run();
-
-```
+use Utopia\Console;
 
-And than, run from command line:
+Console::success('Ready to work!');
 
-```bash
-php script.php command-name --email=me@example.com
-```
+$answer = Console::confirm('Continue? [y/N]');
 
-### Hooks
+if ($answer !== 'y') {
+    Console::warning('Aborting...');
+    Console::exit(1);
+}
 
-There are three types of hooks, init hooks, shutdown hooks and error hooks. Init hooks are executed before the task is executed. Shutdown hook is executed after task is executed before application shuts down. Finally error hooks are executed whenever there's an error in the application lifecycle. You can provide multiple hooks for each stage.
+$output = '';
+$exitCode = Console::execute('php -r "echo \"Hello\";"', '', $output, 3);
 
-```php
-require_once __DIR__ . '/../../vendor/autoload.php';
-
-use Utopia\CLI\CLI;
-use Utopia\CLI\Console;
-use Utopia\Http\Validator\Wildcard;
-
-CLI::setResource('res1', function() {
-    return 'resource 1';
-})
-
-CLI::init()
-    inject('res1')
-    ->action(function($res1) {
-        Console::info($res1);
-    });
-
-CLI::error()
-    ->inject('error')
-    ->action(function($error) {
-        Console::error('Error occurred ' . $error);
-    });
-
-$cli = new CLI();
-
-$cli
-    ->task('command-name')
-    ->param('email', null, new Wildcard())
-    ->action(function ($email) {
-        Console::success($email);
-    });
-
-$cli->run();
+Console::log("Command returned {$exitCode} with: {$output}");
 ```
 
 ### Log Messages
 
 ```php
-Console::log('Plain Log'); // stdout
-```
-
-```php
-Console::success('Green log message'); // stdout
-```
-
-```php
-Console::info('Blue log message'); // stdout
-```
-
-```php
-Console::warning('Yellow log message'); // stderr
-```
-
-```php
-Console::error('Red log message'); // stderr
+Console::log('Plain log');        // stdout
+Console::success('Green log');    // stdout
+Console::info('Blue log');        // stdout
+Console::warning('Yellow log');   // stderr
+Console::error('Red log');        // stderr
 ```
 
 ### Execute Commands
 
-Function returns exit code (0 - OK, >0 - error) and writes stdout, stderr to reference variables. The timeout variable allows you to limit the number of seconds the command can run.
+`Console::execute()` returns the exit code and writes the combined stdout/stderr output into the third argument. Pass a timeout (in seconds) to stop long-running processes and an optional progress callback to stream intermediate output.
 
 ```php
-$stdout = '';
-$stderr = '';
-$stdin = '';
-$timeout = 3; // seconds
-$code = Console::execute('>&1 echo "success"', $stdin, $stdout, $stderr, $timeout);
-
-echo $code; // 0
-echo $stdout; // 'success'
-echo $stderr; // ''
-```
+$output = '';
+$input = '';
+$exitCode = Console::execute('>&1 echo "success"', $input, $output, 3);
 
-```php
-$stdout = '';
-$stderr = '';
-$stdin = '';
-$timeout = 3; // seconds
-$code = Console::execute('>&2 echo "error"', $stdin, $stdout, $stderr, $timeout);
-
-echo $code; // 0
-echo $stdout; // ''
-echo $stderr; // 'error'
+echo $exitCode;  // 0
+echo $output;    // "success\n"
 ```
 
 ### Create a Daemon
 
-You can use the `Console::loop` command to create your PHP daemon. The `loop` method already handles CPU consumption using a configurable sleep function and calls the PHP garbage collector every 5 minutes.
+Use `Console::loop()` to build daemons without tight loops. The helper sleeps between iterations and periodically triggers garbage collection.
 
 ```php
 <?php
 
-use Utopia\CLI\Console;
+use Utopia\Console;
 
-include './vendor/autoload.php';
-
-Console::loop(function() {
+Console::loop(function () {
     echo "Hello World\n";
-}, 1 /* 1 second */);
+}, 1); // 1 second
 ```
 
 ## System Requirements
 
-Utopia Framework requires PHP 7.4 or later. We recommend using the latest PHP version whenever possible.
-
-
+Utopia Console requires PHP 7.4 or later. We recommend using the latest PHP version whenever possible.
 
-## Copyright and license
+## License
 
 The MIT License (MIT) [http://www.opensource.org/licenses/mit-license.php](http://www.opensource.org/licenses/mit-license.php)

composer.json

@@ -1,8 +1,8 @@
 {
-    "name": "utopia-php/cli",
-    "description": "A simple CLI library to manage command line applications",
+    "name": "utopia-php/console",
+    "description": "Console helpers for logging, prompting, and executing commands",
     "type": "library",
-    "keywords": ["php","framework", "upf", "utopia", "cli", "command line"],
+    "keywords": ["php", "utopia", "console", "cli", "terminal"],
     "license": "MIT",
     "scripts": {
         "test": "vendor/bin/phpunit --configuration phpunit.xml < tests/input.txt",
@@ -11,12 +11,10 @@
         "format": "vendor/bin/pint"
     },
     "autoload": {
-        "psr-4": {"Utopia\\CLI\\": "src/CLI"}
+        "psr-4": {"Utopia\\": "src/"}
     },
     "require": {
-        "php": ">=7.4",
-        "utopia-php/framework": "1.0.*",
-        "utopia-php/di": "0.1.*"
+        "php": ">=7.4"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.3",