pforret/saild

Start up all you need for a Laravel Sail dev environment in one go

• start Sail containers (Docker)
• open Sail ssh session (Docker)
• open browser on http://[host name]
• upon closing ssh session, shut down Sail

🔥 Usage

Program : saild  by [email protected]
Version : v1.0.8 (May  8 08:28:56 2024)
Purpose : Start up your Laravel Sail dev environment
Usage   : saild [-h] [-q] [-v] [-f] [-l <log_dir>] [-t <tmp_dir>] [-B <BIN>] [-W <WAIT>] [-U <URL>] <action> <repo?>
Flags, options and parameters:
    -h|--help        : [flag] show usage [default: off]
    -q|--quiet       : [flag] no output [default: off]
    -v|--verbose     : [flag] also show debug messages [default: off]
    -f|--force       : [flag] do not ask for confirmation (always yes) [default: off]
    -l|--log_dir <?> : [option] folder for log files   [default: /Users/pforret/log/saild]
    -t|--tmp_dir <?> : [option] folder for temp files  [default: /tmp/saild]
    -B|--BIN <?>     : [option] sail binary  [default: vendor/bin/sail]
    -W|--WAIT <?>    : [option] seconds to wait for the browser  [default: 5]
    -U|--URL <?>     : [option] URL to open in browser
    <action>         : [choice] action to perform  [options: up,down,install,example,clone,check,env,update]
    <repo>           : [parameter] e.g. '[email protected]:user/laravelproject.git' (optional)

### TIPS & EXAMPLES
* use saild up to start sail, open browser, shell and shut down after
  saild up
* use saild down to shut down the Sail environment
  saild down
* use saild clone to clone and set up a Laravel project on a new machine
  saild clone [email protected]:username/laravelproject.git
* use saild example to generate .env.example from .env
  saild example
* use saild install to install Laravel Sail in an existing project
  saild install
* use saild check to check if this script is ready to execute and what values the options/flags are
  saild check
* use saild env to generate an example .env file (for this script)
  saild env > .env
* use saild update to update to the latest version
  saild update

⚡️ Examples

> saild up
⏳  Docker: start up Sail
[+] Running 7/7
 ⠿ Network project_sail              Created                    0.1s 
 ⠿ Container project-mysql-1         Started                    2.6s
 ⠿ Container project-meilisearch-1   Started                    2.0s 
 ⠿ Container project-mailhog-1       Started                    2.4s 
 ⠿ Container project-redis-1         Started                    2.5s 
 ⠿ Container project-selenium-1      Started                    1.9s 
 ⠿ Container project-laravel.test-1  Started                    3.2s
⏳  Browser: open http://<host name> in 5 secs
⏳  Docker: open bash shell
sail@a163e48d3e8f:/var/www/html$ (...)
exit
⏳  Docker: shut down Sail
[+] Running 7/7
 ⠿ Container project-laravel.test-1  Removed                    0.6s 
 ⠿ Container project-selenium-1      Removed                    4.3s
 ⠿ Container project-redis-1         Removed                    1.2s 
 ⠿ Container project-meilisearch-1   Removed                    1.0s 
 ⠿ Container project-mysql-1         Removed                    2.5s 
 ⠿ Container project-mailhog-1       Removed                    1.4s 
 ⠿ Network project_sail              Removed 
 
 > saild init
 # install Laravel Sail in an existing project
 # https://laravel.com/docs/9.x/sail#installing-sail-into-existing-applications
 
 > saild clone [email protected]:username/laravelproject.git
 # git clone -> composer install -> npm install -> create .env -> key:generate

🚀 Installation

with basher

$ basher install pforret/saild

or with git

$ git clone https://github.com/pforret/saild.git
$ cd saild

📝 Acknowledgements

• script created with bashew

© 2023 Peter Forret