sail.sh

#!/usr/bin/bash

UNAMEOUT="$(uname -s)"

# Verify operating system is supported...
case "${UNAMEOUT}" in
  Linux*) MACHINE=linux ;;
  Darwin*) MACHINE=mac ;;
  *) MACHINE="UNKNOWN" ;;
esac

if [ "$MACHINE" == "UNKNOWN" ]; then
  echo "Unsupported operating system [$(uname -s)]. Laravel Sail supports macOS, Linux, and Windows (WSL2)." >&2

  exit 1
fi

# Determine if stdout is a terminal...
if test -t 1; then
  # Determine if colors are supported...
  ncolors=$(tput colors)

  if test -n "$ncolors" && test "$ncolors" -ge 8; then
    BOLD="$(tput bold)"
    YELLOW="$(tput setaf 3)"
    GREEN="$(tput setaf 2)"
    NC="$(tput sgr0)"
  fi
fi

# Function that prints the available commands...
function display_help {
  echo "Laravel Sail"
  echo
  echo "${YELLOW}Usage:${NC}" >&2
  echo "  sail COMMAND [options] [arguments]"
  echo
  echo "Unknown commands are passed to the docker-compose binary."
  echo
  echo "${YELLOW}docker-compose Commands:${NC}"
  echo "  ${GREEN}sail up${NC}        Start the application"
  echo "  ${GREEN}sail up -d${NC}     Start the application in the background"
  echo "  ${GREEN}sail stop${NC}      Stop the application"
  echo "  ${GREEN}sail restart${NC}   Restart the application"
  echo "  ${GREEN}sail ps${NC}        Display the status of all containers"
  echo
  echo "${YELLOW}Artisan Commands:${NC}"
  echo "  ${GREEN}sail artisan ...${NC}          Run an Artisan command"
  echo "  ${GREEN}sail artisan queue:work${NC}"
  echo
  echo "${YELLOW}PHP Commands:${NC}"
  echo "  ${GREEN}sail php ...${NC}   Run a snippet of PHP code"
  echo "  ${GREEN}sail php -v${NC}"
  echo
  echo "${YELLOW}Composer Commands:${NC}"
  echo "  ${GREEN}sail composer ...${NC}                       Run a Composer command"
  echo "  ${GREEN}sail composer require laravel/sanctum${NC}"
  echo
  echo "${YELLOW}Node Commands:${NC}"
  echo "  ${GREEN}sail node ...${NC}         Run a Node command"
  echo "  ${GREEN}sail node --version${NC}"
  echo
  echo "${YELLOW}NPM Commands:${NC}"
  echo "  ${GREEN}sail npm ...${NC}        Run a npm command"
  echo "  ${GREEN}sail npx${NC}            Run a npx command"
  echo "  ${GREEN}sail npm run prod${NC}"
  echo
  echo "${YELLOW}Database Commands:${NC}"
  echo "  ${GREEN}sail mariadb${NC}   Start a MySQL CLI session within the 'mariadb' container"
  echo "  ${GREEN}sail redis${NC}     Start a Redis CLI session within the 'redis' container"
  echo
  echo "${YELLOW}Debugging:${NC}"
  echo "  ${GREEN}sail debug ...${NC}          Run an Artisan command in debug mode"
  echo "  ${GREEN}sail debug queue:work${NC}"
  echo
  echo "${YELLOW}Running Tests:${NC}"
  echo "  ${GREEN}sail test${NC}          Run the PHPUnit tests via the Artisan test command"
  echo "  ${GREEN}sail phpunit ...${NC}   Run PHPUnit"
  echo "  ${GREEN}sail pest ...${NC}      Run Pest"
  echo "  ${GREEN}sail pint ...${NC}      Run Pint"
  echo "  ${GREEN}sail dusk${NC}          Run the Dusk tests (Requires the laravel/dusk package)"
  echo "  ${GREEN}sail dusk:fails${NC}    Re-run previously failed Dusk tests (Requires the laravel/dusk package)"
  echo
  echo "${YELLOW}Container CLI:${NC}"
  echo "  ${GREEN}sail shell${NC}        Start a shell session within the application container"
  echo "  ${GREEN}sail bash${NC}         Alias for 'sail shell'"
  echo "  ${GREEN}sail root-shell${NC}   Start a root shell session within the application container"
  echo "  ${GREEN}sail root-bash${NC}    Alias for 'sail root-shell'"
  echo "  ${GREEN}sail tinker${NC}       Start a new Laravel Tinker session"
  echo
  echo "  ${GREEN}sail open${NC}    Open the site in your browser"
  echo
  echo "${YELLOW}Binaries:${NC}"
  echo "  ${GREEN}sail bin ...${NC}   Run Composer binary scripts from the vendor/bin directory"
  echo
  echo "${YELLOW}Customization:${NC}"
  echo "  ${GREEN}sail artisan sail:publish${NC}   Publish the Sail configuration files"
  echo "  ${GREEN}sail build --no-cache${NC}       Rebuild all of the Sail containers"

  exit 1
}

# Proxy the "help" command...
if [ $# -gt 0 ]; then
  if [ "$1" == "help" ] || [ "$1" == "-h" ] || [ "$1" == "-help" ] || [ "$1" == "--help" ]; then
    display_help
  fi
else
  display_help
fi

# Source the ".env" file so Laravel's environment variables are available...
if [ ! -z "$APP_ENV" ] && [ -f ./.env.$APP_ENV ]; then
  source ./.env.$APP_ENV
elif [ -f ./.env ]; then
  source ./.env
fi

# Define environment variables...
export APP_PORT=${APP_PORT:-80}
export APP_SERVICE=${APP_SERVICE:-"php"}
export DB_PORT=${DB_PORT:-3306}
export WWWUSER=${WWWUSER:-$UID}
export WWWGROUP=${WWWGROUP:-$(id -g)}

export SAIL_FILES=${SAIL_FILES:-""}

# Function that outputs Sail is not running...
function sail_is_not_running {
  echo "${BOLD}Sail is not running.${NC}" >&2
  echo "" >&2
  echo "${BOLD}You may Sail using the following commands:${NC} './vendor/bin/sail up' or './vendor/bin/sail up -d'" >&2

  exit 1
}

# Define Docker Compose command prefix...
docker compose &> /dev/null
if [ $? == 0 ]; then
  DOCKER_COMPOSE=(docker compose)
else
  DOCKER_COMPOSE=(docker-compose)
fi

if [ -n "$SAIL_FILES" ]; then
  # Convert SAIL_FILES to an array...
  IFS=':' read -ra SAIL_FILES <<< "$SAIL_FILES"

  for FILE in "${SAIL_FILES[@]}"; do
    if [ -f "$FILE" ]; then
      DOCKER_COMPOSE+=(-f "$FILE")
    else
      echo "${BOLD}Unable to find Docker Compose file: '${FILE}'${NC}" >&2

      exit 1
    fi
  done
fi

EXEC="yes"

if [ -z "$SAIL_SKIP_CHECKS" ]; then
  # Ensure that Docker is running...
  if ! docker info > /dev/null 2>&1; then
    echo "${BOLD}Docker is not running.${NC}" >&2

    exit 1
  fi

  # Determine if Sail is currently up...
  if "${DOCKER_COMPOSE[@]}" ps "$APP_SERVICE" 2>&1 | grep 'Exit\|exited'; then
    echo "${BOLD}Shutting down old Sail processes...${NC}" >&2

    "${DOCKER_COMPOSE[@]}" down > /dev/null 2>&1

    EXEC="no"
  elif [ -z "$("${DOCKER_COMPOSE[@]}" ps -q)" ]; then
    EXEC="no"
  fi
fi

ARGS=()

# Proxy PHP commands to the "php" binary on the application container...
if [ "$1" == "php" ]; then
  shift 1

  if [ "$EXEC" == "yes" ]; then
    ARGS+=(exec -u sail)
    [ ! -t 0 ] && ARGS+=(-T)
    ARGS+=("$APP_SERVICE" "php" "$@")
  else
    sail_is_not_running
  fi

elif [ "$1" == "trace" ]; then
  shift 1

  if [ "$EXEC" == "yes" ]; then
    ARGS+=(exec -u sail)
    ARGS+=("$APP_SERVICE" "tail" "-f" "/var/log/laravel/laravel.log")
  else
    sail_is_not_running
  fi

# Proxy vendor binary commands on the application container...
elif [ "$1" == "bin" ]; then
  shift 1

  if [ "$EXEC" == "yes" ]; then
    ARGS+=(exec -u sail)
    [ ! -t 0 ] && ARGS+=(-T)
    ARGS+=("$APP_SERVICE" ./vendor/bin/"$@")
  else
    sail_is_not_running
  fi

# Proxy docker-compose commands to the docker-compose binary on the application container...
elif [ "$1" == "docker-compose" ]; then
  shift 1

  if [ "$EXEC" == "yes" ]; then
    ARGS+=(exec -u sail)
    [ ! -t 0 ] && ARGS+=(-T)
    ARGS+=("$APP_SERVICE" "${DOCKER_COMPOSE[@]}")
  else
    sail_is_not_running
  fi

# Proxy Composer commands to the "composer" binary on the application container...
elif [ "$1" == "composer" ]; then
  shift 1

  if [ "$EXEC" == "yes" ]; then
    ARGS+=(exec -u sail)
    [ ! -t 0 ] && ARGS+=(-T)
    ARGS+=("$APP_SERVICE" "composer" "$@")
  else
    sail_is_not_running
  fi

# Proxy Artisan commands to the "artisan" binary on the application container...
elif [ "$1" == "artisan" ] || [ "$1" == "art" ] || [ "$1" == "a" ]; then
  shift 1

  if [ "$EXEC" == "yes" ]; then
    ARGS+=(exec -u sail)
    [ ! -t 0 ] && ARGS+=(-T)
    ARGS+=("$APP_SERVICE" php artisan "$@")
  else
    sail_is_not_running
  fi

# Proxy the "debug" command to the "php artisan" binary on the application container with xdebug enabled...
elif [ "$1" == "debug" ]; then
  shift 1

  if [ "$EXEC" == "yes" ]; then
    ARGS+=(exec -u sail -e XDEBUG_SESSION=1)
    [ ! -t 0 ] && ARGS+=(-T)
    ARGS+=("$APP_SERVICE" php artisan "$@")
  else
    sail_is_not_running
  fi

# Proxy the "test" command to the "php artisan test" Artisan command...
elif [ "$1" == "test" ]; then
  shift 1

  if [ "$EXEC" == "yes" ]; then
    ARGS+=(exec -u sail)
    [ ! -t 0 ] && ARGS+=(-T)
    ARGS+=("$APP_SERVICE" php artisan test "$@")
  else
    sail_is_not_running
  fi

# Proxy the "pest" command to "php vendor/bin/pest"...
elif [ "$1" == "pest" ]; then
  shift 1

  if [ "$EXEC" == "yes" ]; then
    ARGS+=(exec -u sail)
    [ ! -t 0 ] && ARGS+=(-T)
    ARGS+=("$APP_SERVICE" php vendor/bin/pest "$@")
  else
    sail_is_not_running
  fi

# Proxy the "pint" command to "php vendor/bin/pint"...
elif [ "$1" == "pint" ]; then
  shift 1

  if [ "$EXEC" == "yes" ]; then
    ARGS+=(exec -u sail)
    [ ! -t 0 ] && ARGS+=(-T)
    ARGS+=("$APP_SERVICE" php vendor/bin/pint "$@")
  else
    sail_is_not_running
  fi

# Proxy the "dusk" command to the "php artisan dusk" Artisan command...
elif [ "$1" == "dusk" ]; then
  shift 1

  if [ "$EXEC" == "yes" ]; then
    ARGS+=(exec -u sail)
    [ ! -t 0 ] && ARGS+=(-T)
    ARGS+=(-e "APP_URL=http://${APP_SERVICE}")
    ARGS+=(-e "DUSK_DRIVER_URL=http://selenium:4444/wd/hub")
    ARGS+=("$APP_SERVICE" php artisan dusk "$@")
  else
    sail_is_not_running
  fi

# Proxy the "dusk:fails" command to the "php artisan dusk:fails" Artisan command...
elif [ "$1" == "dusk:fails" ]; then
  shift 1

  if [ "$EXEC" == "yes" ]; then
    ARGS+=(exec -u sail)
    [ ! -t 0 ] && ARGS+=(-T)
    ARGS+=(-e "APP_URL=http://${APP_SERVICE}")
    ARGS+=(-e "DUSK_DRIVER_URL=http://selenium:4444/wd/hub")
    ARGS+=("$APP_SERVICE" php artisan dusk:fails "$@")
  else
    sail_is_not_running
  fi

# Initiate a Laravel Tinker session within the application container...
elif [ "$1" == "tinker" ]; then
  shift 1

  if [ "$EXEC" == "yes" ]; then
    ARGS+=(exec -u sail)
    [ ! -t 0 ] && ARGS+=(-T)
    ARGS+=("$APP_SERVICE" php artisan tinker)
  else
    sail_is_not_running
  fi

# Initiate a MySQL CLI terminal session within the "mariadb" container...
elif [ "$1" == "db" ]; then
  shift 1

  if [ "$EXEC" == "yes" ]; then
    ARGS+=(exec)
    [ ! -t 0 ] && ARGS+=(-T)
    ARGS+=("mariadb" mariadb -u "$DB_USERNAME" "-p$DB_PASSWORD" $DB_DATABASE)
    echo $ARGS
  else
    sail_is_not_running
  fi

# Initiate a Bash shell within the application container...
elif [ "$1" == "shell" ] || [ "$1" == "bash" ]; then
  shift 1

  if [ "$EXEC" == "yes" ]; then
    ARGS+=(exec -u sail)
    [ ! -t 0 ] && ARGS+=(-T)
    ARGS+=("$APP_SERVICE" bash "$@")
  else
    sail_is_not_running
  fi

# Initiate a root user Bash shell within the application container...
elif [ "$1" == "root-shell" ] || [ "$1" == "root-bash" ]; then
  shift 1

  if [ "$EXEC" == "yes" ]; then
    ARGS+=(exec)
    [ ! -t 0 ] && ARGS+=(-T)
    ARGS+=("$APP_SERVICE" bash "$@")
  else
    sail_is_not_running
  fi

# Initiate a Redis CLI terminal session within the "redis" container...
elif [ "$1" == "redis" ]; then
  shift 1

  if [ "$EXEC" == "yes" ]; then
    ARGS+=(exec)
    [ ! -t 0 ] && ARGS+=(-T)
    ARGS+=(redis redis-cli)
  else
    sail_is_not_running
  fi

# Open the site...
elif [ "$1" == "open" ]; then
  shift 1

  if [ "$EXEC" == "yes" ]; then
    open $APP_URL

    exit
  else
    sail_is_not_running
  fi

# Pass unknown commands to the "docker-compose" binary...
else
  ARGS+=("$@")
fi

# Run Docker Compose with the defined arguments...
"${DOCKER_COMPOSE[@]}" "${ARGS[@]}"