PHPackages                             phizzl/deployee - 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. [Utility & Helpers](/categories/utility)
4. /
5. phizzl/deployee

AbandonedArchivedLibrary[Utility & Helpers](/categories/utility)

phizzl/deployee
===============

Taskrunner for PHP

v0.2.1(7y ago)210.8k1GPL-3.0PHPPHP >=5.5.0

Since Oct 4Pushed 7y ago1 watchersCompare

[ Source](https://github.com/phizzl/deployee)[ Packagist](https://packagist.org/packages/phizzl/deployee)[ RSS](/packages/phizzl-deployee/feed)WikiDiscussions master Synced 2d ago

READMEChangelog (10)Dependencies (8)Versions (12)Used By (0)

Deployee task runner
====================

[](#deployee-task-runner)

Setup
-----

[](#setup)

You can require deployee via composer

```
composer require phizzl/deployee @dev
```

Configuration
-------------

[](#configuration)

Create a file called deployee.yml. You might copy it fom vendor/phizzl/deployee-cli/deployee.dist.yml.

### Load specified configuration by an OS environment var

[](#load-specified-configuration-by-an-os-environment-var)

If you want to use another configuration you can change it by setting the environment variable DEPLOYEE\_CONFIG with the absolute path to the configuration to use.

```
export DEPLOYEE_CONFIG=/var/www/custom.deployee.yml; vendor/bin/deployee deployee:deploy:run
```

### Load config by --env option

[](#load-config-by---env-option)

You also are able to load a configuration by defining the --env option

```
vendor/bin/deployee deployee:deploy:run --env=dev
```

In the example above Deployee will try to read the configuration from a file called delpoyee.dev.yml in you current CWD.

Deployments
-----------

[](#deployments)

### Tasks

[](#tasks)

There are several of tasks you can use to define your deployment. The functionality that makes it possible to define a deployment is stored in the Dpeloyment plugin. For more information see the documentation [here](src/Plugins/Deploy/README.md)

#### Filesystem

[](#filesystem)

See documentation [here](src/Plugins/DeployFilesystem/README.md)

#### Shell

[](#shell)

See documentation [here](src/Plugins/DeployShell/README.md)

#### MySQL database

[](#mysql-database)

See documentation [here](src/Plugins/DeployDb/README.md)

#### OXID eShop

[](#oxid-eshop)

See documentation [here](src/Plugins/DeployOxid/README.md)

### Annotation controlled deployments

[](#annotation-controlled-deployments)

You can manipulate the behaviour of when a deplyoment is executed by setting annotations to the deployment definition. If you want to know more about how to force a deployment to run always or only when a specified environment is given take a look at the plugin docs [here](src/Plugins/DeployAnnotation/README.md)

Plugins
-------

[](#plugins)

The system itself is designed to be event and plugin based. So the functionality to define a deployment is a plugin itself that adds events and commands to the system.

### Create a new plugin

[](#create-a-new-plugin)

If you want to add functionality to Deployee you are able to create your own plugin. For this you need a Plugin class that extends the AbstractPlugin class.

```
use Deployee\Container;
use Deployee\Plugins\AbstractPlugin;

class MyPluginPlugin extends AbstractPlugin
{
    const PLUGIN_ID = "deploy.myUniquePluginId";

    /**
     * @return string
     */
    public function getPluginId()
    {
        return self::PLUGIN_ID;
    }

    /**
     * @param Container $container
     */
    public function initialize(Container $container)
    {
        // start subscribing to events
    }
}
```

After you defined your plugin you just have to add your class to your Deployee config YAML file under the *plugin* section.

```
plugins:
    - Deployee\Plugins\MyPlugin\MyPluginPlugin
```

### Plugin configuration parameter

[](#plugin-configuration-parameter)

You can also define your plugin configuration in the config YAML file. This parameters will be available in the plugins initialize method.

```
plugins:
    - Deployee\Plugins\MyPlugin\MyPluginPlugin:
        myvar1: val1
        myvar2: ["apple", "orange"]
```

Than you can access the config vars as in the following example

```
public function initialize(Container $container)
{
    $myvar1 = $this->config['myvar1'];
    if(!isset($this->config['myvar2']) || !is_array($this->config['myvar2'])){
        throw new \RuntimeException("You need to configure myvar2");
    }
}
```

###  Health Score

29

—

LowBetter than 57% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity22

Limited adoption so far

Community5

Small or concentrated contributor base

Maturity55

Maturing project, gaining track record

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 ~37 days

Recently: every ~90 days

Total

11

Last Release

2821d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/9c97e3bef66ef0074ad9f0fe89d74a6bec22b2940cf11f4cb41707e15c316589?d=identicon)[phizzl](/maintainers/phizzl)

### Embed Badge

![Health badge](/badges/phizzl-deployee/health.svg)

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

###  Alternatives

[pimcore/pimcore

Content & Product Management Framework (CMS/PIM/E-Commerce)

3.8k3.8M482](/packages/pimcore-pimcore)[matomo/matomo

Matomo is the leading Free/Libre open analytics platform

21.6k38.2k](/packages/matomo-matomo)[shopware/platform

The Shopware e-commerce core

3.4k1.5M3](/packages/shopware-platform)[friendsoftypo3/content-blocks

TYPO3 CMS Content Blocks - Content Types API | Define reusable components via YAML

103519.9k45](/packages/friendsoftypo3-content-blocks)[craftcms/cms

Craft CMS

3.6k3.6M2.9k](/packages/craftcms-cms)[contao/core-bundle

Contao Open Source CMS

1231.6M2.7k](/packages/contao-core-bundle)

PHPackages © 2026

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