A simple CLI library to manage command line applications

0.14.0 2022-10-09 10:19 UTC

README

Build Status Total Downloads Discord

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.

Although this library is part of the Utopia Framework project it is dependency free and can be used as standalone with any other PHP project or framework.

Getting Started

Install using composer:

composer require utopia-php/cli

script.php

<?php
require_once './vendor/autoload.php';

use Utopia\CLI\CLI;
use Utopia\CLI\Console;
use Utopia\Validator\Wildcard;

$cli = new CLI();

$cli
    ->task('command-name')
    ->param('email', null, new Wildcard())
    ->action(function ($email) {
        Console::success($email);
    });

$cli->run();

And than, run from command line:

php script.php command-name --email=me@example.com

Hooks

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.

require_once __DIR__ . '/../../vendor/autoload.php';

use Utopia\App;
use Utopia\Request;
use Utopia\Response;

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();

Log Messages

Console::log('Plain Log'); // stdout
Console::success('Green log message'); // stdout
Console::info('Blue log message'); // stdout
Console::warning('Yellow log message'); // stderr
Console::error('Red log message'); // 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.

$stdout = '';
$stderr = '';
$stdin = '';
$timeout = 3; // seconds
$code = Console::execute('>&1 echo "success"', $stdin, $stdout, $stderr, $timeout);

echo $code; // 0
echo $stdout; // 'success'
echo $stderr; // ''
$stdout = '';
$stderr = '';
$stdin = '';
$timeout = 3; // seconds
$code = Console::execute('>&2 echo "error"', $stdin, $stdout, $stderr, $timeout);

echo $code; // 0
echo $stdout; // ''
echo $stderr; // 'error'

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.

<?php

use Utopia\CLI\Console;

include './vendor/autoload.php';

Console::loop(function() {
    echo "Hello World\n";
}, 1 /* 1 second */);

System Requirements

Utopia Framework requires PHP 7.4 or later. We recommend using the latest PHP version whenever possible.

Copyright and license

The MIT License (MIT) http://www.opensource.org/licenses/mit-license.php