basuke / clim

PHP Micro framework for command line application inspired by Slim Framework

Clim Framework

PHP Micro framework for command line application inspired by Slim Framework

Features

• Simple yet powerful configuration
• DI Container support
• Sub command dispatch
• Middleware support

Install

$ composer require climphp/clim

Usage

After composer install, create an hello.php file with the following contents:

<?php

require 'vendor/autoload.php';

$app = new Clim\App();

$app->opt('-u|--upper');
$app->arg('name')->default('unknown');

$app->task(function ($opts, $args) {
	$name = $args['name'];

	if ($opts['u']) $name = strtoupper($name);

    echo "Welcome, {$name}\n";
});

$app->run();

Then from the shell:

$ php hello.php Nocchi
Welcome, Nocchi
$ php hello.php -u Kashiyuka
Welcome, KASHIYUKA

For more information on how to configure your clie application, see the Documentation.

Tests

To execute the test suite, you'll need codeception.

$ vendor/bin/codecept run unit

Credits

• Basuke Suzuki

Special thanks to Slim Framework for the archtecture and the api design.

License

The Clim Framework is licensed under the MIT license. See License File for more information.

clim's Issues

Middlewares can be assigned by settings

new App([
  'middlewares' => [
    'Debug',
    'Database', 
    \Some\Middleware::class
  ]
]);

Argument reflection for task

Automated argument passing from container is a fancy feature for cli app.

example:

$app->task(function(\PDO $db, array $args) {
    // $db will be pulled from container
    // equivalent to
    // /** @var \PDO $db */
    // $db = $this->db;
});

No document generator

documentation generator is one of the attracting feature for CLI framework. It can be separate Middleware to be implemented.

task() and dispatch() specific middleware support

it is convenient I can add middleware for specific task() or dispatch().

Handle Ctrl-C correctly

Ctrl-C will be handled in the framework and it will terminate the execution gracefully.