PHPackages                             pointblue/deployer - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [CLI & Console](/categories/cli)
4. /
5. pointblue/deployer

ActiveLibrary[CLI & Console](/categories/cli)

pointblue/deployer
==================

Deployer tasks for Point Blue apps

1.2.53(4y ago)096PHP

Since Nov 11Pushed 1y ago3 watchersCompare

[ Source](https://github.com/pointblue/deployer)[ Packagist](https://packagist.org/packages/pointblue/deployer)[ RSS](/packages/pointblue-deployer/feed)WikiDiscussions master Synced 3d ago

READMEChangelog (10)DependenciesVersions (59)Used By (0)

Point Blue Deployer
===================

[](#point-blue-deployer)

Supporting deployer tasks

Install
-------

[](#install)

This will install the package globally

`composer global require pointblue/deployer`

This package is available from packagist -

### Configuration

[](#configuration)

1. Edit the `php.ini` for your command line environment at `/etc/php/VERSION/cli/php.ini` where `VERSION` is something like `5.6` or `7.2`.
    Find out your php cli version with `php --version`
2. Find composer's global path with `composer config --list --global` and find the property \[home\]. Append `/vendor` to this property and use this path for the next step.
3. Update `include_path` by appending the global composer's vendor path to the end of the string as `:/home/user/.config/composer/vendor` and save the file.
    Example: `include_path = ".:/usr/share/php:/home/ubuntu/.config/composer/vendor"`.
4. Create a file named `.slack_webhook_url` in the home folder of the user that will be running the composer script. The contents of the file should be the url of the slack webhook that will be posted to on deploy completetion. This will enable build notifications to be posted to that url. If this is not done, notifications will not be sent. The recommended permission for the file is 600 (`chmod 600 .slack_webhook_url`).

Use
---

[](#use)

### deployer.php

[](#deployerphp)

To use the deployer tasks, just require the tasks in your `deployer.php` file at the top, but after other required files.

*Example:*

```

//deployer's common tasks
require 'recipe/common.php';

//Point Blue's deployter tasks
require 'pointblue/deployer/common-tasks.php';

```

Next, add the hooks need for the tasks to run:

```
//right before release, call the point blue deployer hooks
after('deploy:clear_paths', 'deploy:pb_deployer_post_hook');

```

### cli

[](#cli)

To test commands without running them on the target server, use the `--pb-test` option.

*Example:*

`dep deploy:symlink_envs aws --pb-test -vvv`

This will run the `deploy:symlink_envs` task with the aws stage settings from the `servers.yml` file and print the symlink commands in the console instead of running them on the server. This will let you test your configurations before deploying.

servers.yml variables
---------------------

[](#serversyml-variables)

Some additional variables can be added to your hosts definition in the `servers.yml` file.

`env_symlinks` - see `deploy:symlink_envs` in `common-tasks.php`
`update_autoload_classmap` - see `deploy:update_autoload_classmap` in `common-tasks.php`

Development
-----------

[](#development)

Notes on developing this project.

### Symlink to global composer path (optional)

[](#symlink-to-global-composer-path-optional)

It's best to symlink this project from your global composer path. This way your edits can be tested right away.

This is how I used a symlink on my system:

```
martin@lat3351:~/.config/composer/vendor/pointblue$ ln -sf /home/martin/Workspace/devops/devenv/deployer deployer

```

This allows the `require 'pointblue/deployer/common-tasks.php';` line in `deploy.php` to refer to the pointblue/deployer repo I cloned. Now my edits are under source control and can be tested lived.

### Use debug tasks

[](#use-debug-tasks)

You can run debug tasks from you machine to see how individual functions behave and drop break points.

- From the command line, go to a locally cloned repo that uses common-tasks.php in it's deploy.php file
- Run `dep debug:say_hello prod` where `prod` is any target machine you can deploy to (from your current command line)
- You should be able to see 'hello, world!' printed in your console
- You should also be able to set a breakpoint on this line in PHPStorm
- Use this pattern to create more debug tasks

Reference
---------

[](#reference)

Please see the source code for task names and their use

###  Health Score

36

—

LowBetter than 82% of packages

Maintenance36

Infrequent updates — may be unmaintained

Popularity9

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity75

Established project with proven stability

 Bus Factor1

Top contributor holds 97.4% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~18 days

Recently: every ~119 days

Total

56

Last Release

1738d ago

PHP version history (3 changes)1.0PHP ^5.6

1.1PHP >=5.6

1.2PHP >=5.6 >=7.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/5c6b3841f7ebf4030fac856b7b6259c0d12b8a8543099cfa125f7651894f8477?d=identicon)[pointblueconsci](/maintainers/pointblueconsci)

---

Top Contributors

[![stereocilia](https://avatars.githubusercontent.com/u/3218802?v=4)](https://github.com/stereocilia "stereocilia (74 commits)")[![dm00dy](https://avatars.githubusercontent.com/u/12535173?v=4)](https://github.com/dm00dy "dm00dy (1 commits)")[![ktohalloran](https://avatars.githubusercontent.com/u/77936689?v=4)](https://github.com/ktohalloran "ktohalloran (1 commits)")

### Embed Badge

![Health badge](/badges/pointblue-deployer/health.svg)

```
[![Health](https://phpackages.com/badges/pointblue-deployer/health.svg)](https://phpackages.com/packages/pointblue-deployer)
```

###  Alternatives

[wp-cli/wp-cli

WP-CLI framework

5.0k17.2M320](/packages/wp-cli-wp-cli)[consolidation/annotated-command

Initialize Symfony Console commands from annotated command class methods.

22569.8M19](/packages/consolidation-annotated-command)[chi-teck/drupal-code-generator

Drupal code generator

26947.8M5](/packages/chi-teck-drupal-code-generator)[seld/cli-prompt

Allows you to prompt for user input on the command line, and optionally hide the characters they type

24725.8M17](/packages/seld-cli-prompt)[illuminate/console

The Illuminate Console package.

12944.1M5.1k](/packages/illuminate-console)[php-tui/php-tui

Comprehensive TUI library heavily influenced by Ratatui

589747.0k6](/packages/php-tui-php-tui)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)