This repository houses the source for and PHAR archive of the Terminus Installer script. Its goal is to provide a fail-proof installation method for users less familiar with manual installation methods such as Composer and Git, or those simply wanting a single-step process to get it running on their local machines.
Component | Description | Notes |
---|---|---|
bin | User-executable scripts | |
builds | PHAR copies of the script | |
scripts | Scripts for creating PHAR archives of the source and maintaining the source code | |
src | Source code for the script | |
tests | Tests for maintaining the codebase |
Use the following line to install Terminus:
curl -O https://raw.githubusercontent.com/pantheon-systems/terminus-installer/master/builds/installer.phar && php installer.phar install
composer install
at the repository root directory to install all necessary dependencies.Your pull request will be reviewed by Pantheon and changes may be requested before the code is accepted.
No tips at present.
bin
directory is unavailable, Terminus cannot be automatically set up as a command. A symlink or an alias
to the Terminus executable be made in either the ~/.bashrc
or ~/.bash_profile
files.There are options you can set to configure your installation.
--bin-dir=<dir>
Where <dir>
is the location of your bin directory. Defaults to /usr/local/bin
.--install-dir=<dir>
Where <dir>
is the directory to which you want Composer to install Terminus. If not given, Terminus will be installed to your current working directory.--install-version=<version>
Where <version>
is any released version of Terminus. If not given, the latest version will be installed.These can be used by adding them to the installer call from above like so:
curl -O https://raw.githubusercontent.com/pantheon-systems/terminus-installer/master/builds/installer.phar && php installer.phar install --install-version=1.2.3 --install-dir=/tmp/terminus
Tests are run via the .scripts/test.sh
script. Components thereof can be run as follows:
composer cs
runs the code sniffer to ensure all code is appropriately formatted.composer phpunit
runs the PHPUnit unit tests.composer behat
runs the Behat feature testsDependencies are easily updated by Composer. To update this codebase:
composer update
at the repository root directory.New versions are automatically deployed once an update is accepted into the master branch.