Installation

Two install modes:

Global Installation

Install via Composer:

composer global require deployer/deployer

Or via Phive:

phive install deployer

:::tip Path to Executable

Composer's global bin directory must be on your PATH. Add to .bashrc / .zshrc:

export PATH="$HOME/.composer/vendor/bin:$PATH"

Reload the shell config (source ~/.bashrc or source ~/.zshrc).

:::

Create the deploy.php recipe in your project:

dep init

Shell completion covers task names, options, hosts, and configs.

Bash — write the script and make sure .bashrc sources it:
sh
```
dep completion bash > /etc/bash_completion.d/deployer
```
Zsh — write to a directory listed in your fpath:
sh
```
dep completion zsh > ~/.zsh/completion/_deployer
```

Fish — Fish auto-loads from this path:

dep completion fish > ~/.config/fish/completions/deployer.fish

Pins the Deployer version per project — preferred for CI/CD.

composer require --dev deployer/deployer

:::tip Configuring Shell Alias Add an alias so you can type dep instead of vendor/bin/dep:

alias dep='vendor/bin/dep'

:::

Initialize the recipe:

vendor/bin/dep init

A Phar bundle is also available — see the download page. Commit deployer.phar to your repo to lock the version across local and CI environments.

php deployer.phar init

No Composer required.