cilex/cilex

The PHP micro-framework for Command line tools based on the Symfony2 Components

Cilex, a simple Command Line Interface framework

Cilex is a simple command line application framework to develop simple tools based on Symfony2 components:, _(*1)

<?php
if (!$loader = include __DIR__.'/vendor/autoload.php') {
    die('You must set up the project dependencies.');
}

$app = new \Cilex\Application('Cilex');
$app->command(new \Cilex\Command\GreetCommand());
$app->command('foo', function ($input, $output) {
    $output->writeln('Example output');
});
$app->run();

Cilex works with PHP 5.5.9 or later and is heavily inspired by the Silex web micro-framework by Fabien Potencier., _(*2)

Installation

1. git clone this repository.
2. Download composer: curl -s https://getcomposer.org/installer | php
3. Install Cilex' dependencies: php composer.phar install

Usage

• Create your new commands in src/Cilex/Command/
• Add your new commands to bin/run.php
• Run the commands as:

./bin/run.php demo:greet world
./bin/run.php demo:greet world -y
./bin/run.php demo:greet world --yell
./bin/run.php demo:info

Creating a PHAR

• Download and install [box][5]:

curl -LSs http://box-project.org/installer.php | php
chmod +x box.phar
mv box.phar /usr/local/bin/box

• Update the project phar config in box.json
• Create the package:

box build

• Run the commands:

./cilex.phar demo:greet world
./cilex.phar demo:greet world -y
./cilex.phar demo:greet world --yell
./cilex.phar demo:info

• enjoy a lot.

License

Cilex is licensed under the MIT license., _(*3)

FAQ

Q: How do I pass configuration into the application?, _(*4)

A: You can do this by adding the following line, where $configPath is the path to the configuration file you want to use:, _(*5)

$app->register(new \Cilex\Provider\ConfigServiceProvider(), array('config.path' => $configPath));

The formats currently supported are: YAML, XML and JSON, _(*6)