deployer/docs/installation.md
Eric San 711db81d3f
Fix a little typo and improve a little clarity. (#2649)
Fix a typo.

Added "~/" to be clear that this is in user's "Home" directory.

Added `~/.zshrc` as some user uses ZSH terminal.
2021-09-14 21:13:21 +02:00

1.5 KiB
Executable File

Installation

Phar is the best distribution mechanism for a tool.

Globally

To install Deployer as phar archive globally, run the following commands:

curl -LO https://deployer.org/deployer.phar
mv deployer.phar /usr/local/bin/dep
chmod +x /usr/local/bin/dep

After installing Deployer globally with will be able to initialize a recipe in new project with just dep init command.

If you need another version of Deployer, you can find it on the download page. Later, to upgrade Deployer, run the command:

dep self-update

To upgrade to the next major release, if available, use the --upgrade (-u) option:

dep self-update --upgrade

Distribution

composer require deployer/dist --dev

Then to use Deployer, run the following command:

php vendor/bin/dep

This is preferred method of installing Deployer in composer project. In distribution repo only phar is committed, and its dependencies will not conflict with your project dependencies.

Download deployer.phar and commit it. Totally okay. Update it via with dep self-update.

Source

Use it if you really need Deployer source files.

composer require deployer/deployer --dev

Autocomplete

Deployer comes with an autocomplete support for bash & zsh, so you don't need to remember task names and options.

Add next line to your ~/.bash_profile or ~/.zshrc:

eval "$(dep autocomplete)"

Read getting started next.