README

Run predefined chains of Artisan and shell commands in your Laravel application with a single command.

This package allows you to define “chains” of commands (both Artisan and shell commands like npm install or composer update) and run them sequentially in a clean, visual way in your terminal.

📦 Installation

Require the package in your Laravel project (local or via Packagist):

composer require suhailparad/lara-command-chain

(Optional) If developing locally, add repository path in composer.json:

"repositories": [
    {
        "type": "path",
        "url": "packages/lara-command-chain"
    }
]

⚙️ Publish Configuration

php artisan vendor:publish --tag=command-chain-config

This will publish config/command-chain.php where you can define your chains.

📝 Configuration

config/command-chain.php example:

return [
    'chains' => [
        'setup' => [
            'php artisan migrate:fresh',
            'php artisan db:seed',
            'php artisan cache:clear',
        ],
        'deploy' => [
            'php artisan down',
            'composer update',
            'npm install',
            'php artisan migrate',
            'php artisan up',
        ],
    ],
];

Each chain is a named array of commands.
Commands can be Artisan commands (php artisan ...) or shell commands (npm install, composer update, git pull, etc.).

🚀 Usage

Run a chain:

php artisan chain:run setup
php artisan chain:run deploy

Output Example

⚡ Running chain: deploy

[1/4] php artisan down ... ✅ done (0.1s)
[2/4] composer update ... 🚀 running...
Updating dependencies...
Generating optimized autoload files...
[2/4] composer update ... ✅ done (6.3s)
[3/4] php artisan migrate ... ✅ done (0.2s)
[4/4] php artisan up ... ✅ done (0.1s)

⚡ Chain [deploy] completed!

🛠 Dry Run

Check what commands would run without executing:

php artisan chain:run deploy --dry-run

Example output:

⏭️  [1/4] php artisan down ... skipped (dry run)
⏭️  [2/4] composer update ... skipped (dry run)
⏭️  [3/4] php artisan migrate ... skipped (dry run)
⏭️  [4/4] php artisan up ... skipped (dry run)

🔧 Features

Run multiple Artisan or shell commands in sequence.
✅ Shows status (done / failed / skipped) with icons.
⏱ Shows duration for each command.
Dry-run support (--dry-run) to preview chains.
Works with long-running commands like npm install or composer update.
Fully configurable via config/command-chain.php.

⚡ Example Chains

'chains' => [
    'build' => [
        'npm install',
        'npm run build',
    ],
    'deploy' => [
        'php artisan down',
        'composer install',
        'php artisan migrate',
        'php artisan up',
    ],
];

Run them:

php artisan chain:run build
php artisan chain:run deploy

📄 Contribution

Fork the repository.
Create your feature branch: git checkout -b feature/new-chain.
Commit your changes: git commit -m 'Add new chain feature'.
Push to the branch: git push origin feature/new-chain.
Submit a pull request.

suhailparad / lara-command-chain

Maintainers

Package info

Statistics

Security