README

This is distribution of the Joomla Framework for you to use as a skeleton for command-line applications (CLI's).

1. Installation

You have two options to install the Joomla CLI Application.

Use Composer (recommended)

The Joomla Framework uses Composer to manage dependencies. The easiest way to install the Joomla CLI Application base is to create a project for you.

If you don't have Composer, follow the installation instructions on the http://getcomposer.org site.

Then, use the create-project command to download and prepare your command-line application:

$ php composer.phar create-project -s dev theartofjoomla/joomla-cli-application path/to/install

Composer will install the project under the path/to/install folder and automatically download all the dependencies into the path/to/install/vendor folder.

2. Configuring the application

The application comes with based configuration support so copy or rename the /etc/config.dist.json file to /etc/config.json.

3. Testing the application

The executable file is /bin/run.php.

$ php bin/run.php
[2013-09-30 14:28:35] Acme.DEBUG: It works! [] []
$

4. Extending the application

Rename the "Acme" string and /src/Acme to the name of your application.
Add more packages and dependencies by modifying /composer.json.

5. Features

JSON configuration file support (/etc/config.json).
Monolog logging to STDOUT.
Exception tracing.

6. More help

Browse the tutorials on building a command line application at Learn the Art of Joomla - Framework Solutions.

theartofjoomla / joomla-cli-application

Maintainers

Details