halilcosdu/laravel-command-banner

Laravel Command Banner: Prevents Commands from Running in Defined Environments

v1.0.1 2024-05-11 21:09 UTC

Requires

• php: ^8.2
• illuminate/support: ^10.0|^11.0

Requires (Dev)

• larastan/larastan: ^2.9
• laravel/pint: ^1.14
• nunomaduro/collision: ^8.1.1||^7.10.0
• orchestra/testbench: ^9.0.0||^8.22.0
• pestphp/pest: ^2.34
• pestphp/pest-plugin-arch: ^2.7
• pestphp/pest-plugin-laravel: ^2.3
• phpstan/extension-installer: ^1.3
• phpstan/phpstan-deprecation-rules: ^1.1
• phpstan/phpstan-phpunit: ^1.3

MIT

• Halil Cosdu

• php
• configuration
• security
• console
• command
• development
• laravel
• banner
• environment
• production
• protection
• artisan
• disable
• staging
• prevent
• laravel-package
• Halil Cosdu
• command-blocking
• command-banner

README

The "Laravel Command Banner" is a package designed to provide control over the execution of artisan commands in different environments. It allows developers to define which commands should be prevented from running in specific environments, enhancing the security and stability of the application. The package works by listening to the CommandStarting event in Laravel. When a command is about to start, it checks the package's configuration to see if the command is allowed to run in the current environment. If the command is not allowed, it outputs an error message and stops the execution of the command. This package is particularly useful in scenarios where certain commands can have destructive effects if run in the wrong environment, such as a production environment. By using this package, developers can ensure that such commands are only run in safe environments, such as local or staging environments.

Installation

You can install the package via composer:

composer require halilcosdu/laravel-command-banner

You can publish the config file with:

php artisan vendor:publish --tag="command-banner-config"

This is the contents of the published config file:

You can add as many environments and different commands to the configuration file as you need.

The package will prevent the commands listed in the configuration file from running in the specified environments.

<?php

return [
    'enabled' => env('COMMAND_BANNER_ENABLED', true),
    'environments' => [
        'production' => [
            'db:wipe',
            'migrate:fresh',
        ],
        'staging' => [
            //   'db:show'
        ],
    ],
];

Example Screen

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Halil Cosdu
• All Contributors

License

The MIT License (MIT). Please see License File for more information.