sfneal/cruise

Cruise is a Laravel Sail inspired CLI for managing Docker services

2.1.1 2024-10-08 16:26 UTC

Requires

• php: ^8.2|^8.3
• laravel/framework: ^11.0
• symfony/process: ^6.0|^7.0

Requires (Dev)

• orchestra/testbench: ^9.0
• phpunit/phpunit: ^11.0

MIT

• Stephen Neal

• cruise
• sfneal

README

Cruise is a Laravel Sail inspired CLI for managing Docker services

Installation

You can install the package via composer:

composer require sfneal/cruise

Run the cruise install command to publish cruise assets.

This will add Dockerfiles, docker compose configs & other docker assets to your application root.

php artsian cruise:install

Run the cruise uninstall command to remove published cruise assets

php artsian cruise:uninstall

Usage

Once the php artsian cruise:install command has been run you will have access to various command and utilities for running & testing your laravel application

Artisan commands

Composer commands

Testing

composer test

Cookbook

Create a new Laravel application with Laravel Breeze & cruise installed

# Create new Laravel app
composer create-project laravel/laravel test-app
cd test-app

# Install front-end dependencies
yarn install

# Install breeze
composer require laravel/breeze --dev
php artisan breeze:install

# Remove sail - replaced by cruise
composer remove laravel/sail

# Install cruise
composer require sfneal/cruise
php artisan cruise:install


# Start application running in dev environment
composer start-dev

# Stop application
composer stop

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Stephen Neal

License

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

PHP Package Boilerplate

This package was generated using the PHP Package Boilerplate.