Installation

Getting Magallanes installed and ready-to-go should only take a few minutes. If it ever becomes a pain in the ass, please file an issue (or submit a pull request) describing the issue you encountered and how we might make the process easier.

Requirements

Installing Magallanes is easy and straight-forward, but there are a few requirements you’ll need to make sure your system has before you start.

• Shell Access - Magallanes is a command line utility, therefore you will need access to a shell/terminal environment.
• PHP 5.3+ - Yes, it’s time to grow up. Make sure that the PHP binary is on your shell path.
• Linux, Unix, or Mac OS X

Running Magallanes on Windows

While Windows is not officially supported, it is possible to get it running on Windows. Special instructions can be found on our Windows-specific docs page.

Installing Magallanes System-wide (Recommended)

The best way and simplest to install Magallanes is via Bash. At the terminal prompt, simply run the following command to install Magallanes:

$ wget https://magephp.github.io/download/magallanes.latest.tar.gz -O magallanes.tar.gz
$ tar xfz magallanes
$ cd magallanes
$ bin/mage install --systemWide --installDir=/opt/magallanes

The install command will copy the downloaded version to the configured --installDir. If you want to make it available to all users, then you can perform a --systemWide installation, this will create a symbolic link in /usr/bin/mage to the installation’s executable; you have to be root or super user to perform a system wide install. If you have problems installing Magallanes, check out the troubleshooting page or report an issue so the Magallanes community can improve the experience for everyone.

Compile to PHAR archive

If you would like to take Magallanes with you, you can also compile into a PHAR your current install, with the compile command, which will create a mage.phar file. In order for this to work, you must set the phar.readonly php.ini variable to Off, at least on your cli configuration.

$ mage compile
$ php mage.phar version

Installing with Composer

If you want to have all your tools defined in your project, now you can configure composer to install Magallanes! It’s quite simple, just add the requirement line below to your project’s composer.json file. Also mage is declared as a vendor binary, so you can invoke Magallanes using bin/mage. Pretty neat, right?!

"require-dev": {
  "magephp/magallanes": "~1.1"
},
"config": {
  "bin-dir": "bin"
}

Then we update the vendors:

~ $ cd my-project
~/my-project $ composer update magephp/magallanes

And finally we can use Magallanes from the vendor’s bin:

~/my-project $ bin/mage version

Upgrade

Just as Install, Upgrading is very, very easy! Just run the upgrade command and Magallanes will auto-upgrade itself. Also with version you can find out the current installed version. Check out the upgrading page for more information.

Now that you’ve got everything installed, let’s get to work!

Back

Next