README

Up! is a simple library for running Composer commands from within your application.

Up! works by extending Composer's internal library and adding some simple methods which handle most of the configuration and setup for you.

Up! currently supports three key Composer features:

• Update - Update all modules as specified in the composer.json file.
• Install - Synchronise all modules with versions specified in the composer.lock file, unless no file is present then use the composer.json file
• Create project - Create a project from a package on packagist.org

Up! will assume that the relevant Composer configuration files are in the current working directory, unless specified via the setBaseDir() method

Usage examples

    <?php

    use Mothership\Up\Up;

    $up = new Up;

    // Update your project from the current working directory
    $up->update();

    // Update your project from a different directory
    $up->setBaseDir('/path/to/project')->update();

    // Synchronise your project with the `composer.lock` file
    $up->install();

    // Synchronise your project from a `composer.lock` file in a different directory
    $up->setBaseDir('/path/to/project')->install();

    // Create a new project from a Composer package
    $up->createProject('mothership-ec/mothership');

    // Create a new project from a Composer package in a different directory
    $up->setBaseDir('/path/to/project')->createProject('mothership-ec/mothership');

Installation

Up! must be installed using Composer by adding mothership-ec/up to your composer.json file. See the Composer documentation for more information.

Caveats

• Up! currently uses a forked version of Composer as Composer itself does not utilise semantic versioning
• Up! should be used responsibly. Since it sits on top of Composer's code base, it is only as secure as Composer is, and any security issues with Composer apply to Up! as well. On top of this, Up! is meant to be used as a tool, and it is the responsibility of the developer to ensure that they do not break their application by allowing automatic updates. By using Composer and/or Up!, you are putting your faith into the libraries you use that they will respect semantic versioning and not introduce backwards compatibility breaking changes in their minor updates or hotfixes.