Composer - Package Management for PHP ===================================== Composer is a package manager tracking local dependencies of your projects and libraries. See [http://getcomposer.org/](http://getcomposer.org/) for more information and documentation. [![Build Status](https://secure.travis-ci.org/composer/composer.png?branch=master)](http://travis-ci.org/composer/composer) Installation / Usage -------------------- 1. Download the [`composer.phar`](http://getcomposer.org/composer.phar) executable or use the installer. ``` sh $ curl -s http://getcomposer.org/installer | php ``` 2. Create a composer.json defining your dependencies. Note that this example is a short version for applications that are not meant to be published as packages themselves. To create libraries/packages please read the [guidelines](http://packagist.org/about). ``` json { "require": { "monolog/monolog": ">=1.0.0" } } ``` 3. Run Composer: `php composer.phar install` 4. Browse for more packages on [Packagist](http://packagist.org). Installation from Source ------------------------ To run tests, or develop Composer itself, you must use the sources and not the phar file as described above. 1. Run `git clone https://github.com/composer/composer.git` 2. Download the [`composer.phar`](http://getcomposer.org/composer.phar) executable 3. Run Composer to get the dependencies: `cd composer && php ../composer.phar install` You can now run Composer by executing the `bin/composer` script: `php /path/to/composer/bin/composer` Global installation of Composer (manual) ---------------------------------------- Since Composer works with the current working directory it is possible to install it in a system wide way. 1. Change into a directory in your path like `cd /usr/local/bin` 2. Get Composer `curl -s http://getcomposer.org/installer | php` 3. Make the phar executable `chmod a+x composer.phar` 4. Change into a project directory `cd /path/to/my/project` 5. Use Composer as you normally would `composer.phar install` 6. Optionally you can rename the composer.phar to composer to make it easier Global installation of Composer (via homebrew) ---------------------------------------------- Composer is part of the homebrew-php project. 1. Tap the homebrew-php repository into your brew installation if you haven't done yet: `brew tap josegonzalez/homebrew-php` 2. Run `brew install josegonzalez/php/composer`. 3. Use Composer with the `composer` command. Updating Composer ----------------- Running `php composer.phar self-update` or equivalent will update a phar install with the latest version. Contributing ------------ All code contributions - including those of people having commit access - must go through a pull request and approved by a core developer before being merged. This is to ensure proper review of all the code. Fork the project, create a feature branch, and send us a pull request. To ensure a consistent code base, you should make sure the code follows the [Coding Standards](http://symfony.com/doc/2.0/contributing/code/standards.html) which we borrowed from Symfony. If you would like to help take a look at the [list of issues](http://github.com/composer/composer/issues). Community --------- The developer mailing list is on [google groups](http://groups.google.com/group/composer-dev) IRC channels are available for discussion as well, on irc.freenode.org [#composer](irc://irc.freenode.org/composer) for users and [#composer-dev](irc://irc.freenode.org/composer-dev) for development. Requirements ------------ PHP 5.3.2 or above (at least 5.3.4 recommended to avoid potential bugs) Authors ------- Nils Adermann - - -
Jordi Boggiano - - -
See also the list of [contributors](https://github.com/composer/composer/contributors) who participated in this project. License ------- Composer is licensed under the MIT License - see the LICENSE file for details Acknowledgments --------------- - This project's Solver started out as a PHP port of openSUSE's [Libzypp satsolver](http://en.opensuse.org/openSUSE:Libzypp_satsolver). - This project uses hiddeninput.exe to prompt for passwords on windows, sources and details can be found on the [github page of the project](https://github.com/Seldaek/hidden-input).