climphp/clim

Clim is a PHP micro framework that helps you quickly write simple yet powerful command line applications

Clim Framework

PHP Micro framework for command line application inspired by Slim Framework, _(*1)

, _(*2)

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:, _(*3)

<?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:, _(*4)

$ 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., _(*5)

Tests

To execute the test suite, you'll need codeception., _(*6)

$ vendor/bin/codecept run unit

Credits

• Basuke Suzuki

Special thanks to Slim Framework for the archtecture and the api design., _(*7)

License

The Clim Framework is licensed under the MIT license. See License File for more information., _(*8)