README

Envoyer Deploy Commands

Envoyer Deploy Commands is a simple Laravel package providing Artisan commands to deploy through Envoyer using the API.

Requirements

• PHP >= 8.1
• Laravel >= 9.0

Installation

Install via Composer:

$ composer require log1x/envoyer-deploy-commands --dev

Getting Started

Start by publishing the package configuration:

$ php artisan vendor:publish --tag=envoyer-deploy-config

Customize the configuration adding your Envoyer API key with the deployments:create permission scope.

After adding an API key, you can list the available projects and their corrosponding ID's:

$ php artisan deploy:list [search]

Once you have your project ID, add it the projects section of config/envoyer.php along with an alias (e.g. production).

Usage

Usage is extremely straight forward. Use the artisan deploy command optionally specifying your project alias. If you only have 1 project, it will be used by default.

$ php artisan deploy [alias]

You can also get detailed information on your project using the artisan deploy:info command:

$ php artisan deploy:info [alias]

Bug Reports

If you discover a bug in Envoyer Deploy Commands, please open an issue.

Contributing

Contributing whether it be through PRs, reporting an issue, or suggesting an idea is encouraged and appreciated.

License

Envoyer Deploy Commands is provided under the MIT License.