PHPackages                             webregulate/deploy-helper - 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. webregulate/deploy-helper

Abandoned → [webregulate/dev-companion](/?search=webregulate%2Fdev-companion)Library[CLI & Console](/categories/cli)

webregulate/deploy-helper
=========================

An easy to use cli interface for deploying changes, commits, files etc, and the ability to run npm commands, and deploying builds to a live server

v1.1.12(2y ago)0155MITPHP

Since Apr 29Pushed 2y ago1 watchersCompare

[ Source](https://github.com/Zephni/deploy-helper)[ Packagist](https://packagist.org/packages/webregulate/deploy-helper)[ RSS](/packages/webregulate-deploy-helper/feed)WikiDiscussions main Synced yesterday

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

Deploy Helper
=============

[](#deploy-helper)

---

-- Installation --
------------------

[](#---installation---)

### 1. Require with composer

[](#1-require-with-composer)

```
composer require webregulate/deploy-helper --dev

```

### 2. IMPORTANT: Add the following to your .gitignore file

[](#2-important-add-the-following-to-your-gitignore-file)

```
deployhelper.json

```

### 3. Run the install script

[](#3-run-the-install-script)

```
php ./vendor/webregulate/deploy-helper/install.php

```

This will create the default `deployhelper.json` config, and `deployhelper` PHP script in the root of your project.

### 4. Setting up deployhelper.json

[](#4-setting-up-deployhelperjson)

Note that you can use `{env:keyName}` to inject the current value of an environment variable into the command. This is useful for setting up the build directory, application directory, and other environment specific values.

```
{
    "config": {
        "commands": {
            "deploy": [
                "local rmdir /s /q \"{env:buildDirectory}\"",
                "local cd {env:applicationDirectory} && npm run build",
                "git",
                "build"
            ]
        }
    },
    "environments": {
        "devserver": {
            "remoteBasePath": "/home/unixuser/",
            "localPrivateKeyPath": "/local/path/to/private/key",
            "host": "example.com",
            "user": "unixuser",
            "pass": "unixpassword",
            "port": 22,
            "applicationDirectory": "laravel_application",
            "buildDirectory": "public_html/build",
            "activeGitChangesIgnoreFiles": ["*deployhelper*", "*.htaccess", "*.env", "*rundev.bat"]
        },
        "production": {
            "remoteBasePath": "/home/unixuser2/",
            "localPrivateKeyPath": "/local/path/to/private/key",
            "host": "example2.com",
            "user": "unixuser2",
            "pass": "unixpassword2",
            "port": 22,
            "applicationDirectory": "laravel_application",
            "buildDirectory": "public_html/build",
            "activeGitChangesIgnoreFiles": ["*deployhelper*", "*.htaccess", "*.env", "*rundev.bat"]
        }
    }
}

```

Note you can add or remove any of the groups (such as the devserver and production groups above) based on your setup. Only one is required.

---

-- Running DeployHelper --
--------------------------

[](#---running-deployhelper---)

### Run with php

[](#run-with-php)

```
php ./deployhelper

```

#### More help coming soon...

[](#more-help-coming-soon)

###  Health Score

23

—

LowBetter than 26% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity10

Limited adoption so far

Community4

Small or concentrated contributor base

Maturity47

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

Total

10

Last Release

739d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/4312475?v=4)[Craig Dennis](/maintainers/Zephni)[@Zephni](https://github.com/Zephni)

### Embed Badge

![Health badge](/badges/webregulate-deploy-helper/health.svg)

```
[![Health](https://phpackages.com/badges/webregulate-deploy-helper/health.svg)](https://phpackages.com/packages/webregulate-deploy-helper)
```

###  Alternatives

[illuminate/console

The Illuminate Console package.

13046.0M6.5k](/packages/illuminate-console)[styleci/cli

The CLI tool for StyleCI

71470.5k9](/packages/styleci-cli)[winbox/args

Windows command-line formatter

20720.9k21](/packages/winbox-args)[tomatophp/filament-artisan

Simple but yet powerful library for running some artisan commands for FilamentPHP

3275.4k1](/packages/tomatophp-filament-artisan)[thettler/laravel-console-toolkit

This Package provides some usefully console features like the attribute syntax for arguments and options, validation, auto ask and casting.

324.1k](/packages/thettler-laravel-console-toolkit)

PHPackages © 2026

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