larasail
Quickly build and manage Laravel applications
TLDR
Set up the server with Laravel dependencies using the default PHP version
Set up the server with Laravel dependencies using a specific PHP version
Add a new Laravel site
Retrieve the Larasail user password
Retrieve the Larasail MySQL password
SYNOPSIS
larasail [command] [options]
PARAMETERS
new [project_name]
Creates a new Laravel project with the specified name.
up
Starts the Docker containers for the Laravel project.
down
Stops the Docker containers for the Laravel project.
db [database_name]
Creates a new database within the Docker environment with specified name.
migrate
Runs the Laravel database migrations.
seed
Runs the Laravel database seeders.
--help
Displays help information about LaraSail commands.
DESCRIPTION
LaraSail is a command-line tool designed to streamline the setup and management of Laravel development environments, specifically targeting users who are new to Laravel or prefer a simplified workflow. It provides a series of commands to automate tasks like creating new projects, setting up databases, configuring web servers (primarily using Docker), and installing common Laravel packages. LaraSail aims to abstract away much of the complexity involved in configuring a local development environment, allowing developers to focus on writing code rather than wrestling with configuration files. It uses Docker containers to ensure consistency across different operating systems and avoids the need for users to manually install and configure PHP, MySQL, and other dependencies.
The tool typically integrates with popular database systems and webservers (like Nginx) and uses configuration files to easily spin up multiple projects with different stack configurations. LaraSail's user interface is simple and command-line focused to provide minimal interaction with underlying systems.
CAVEATS
LaraSail relies heavily on Docker. Therefore, Docker must be installed and configured correctly before using LaraSail. It might not support highly customized or complex development environments directly without modification.
CONFIGURATION
LaraSail often uses a configuration file (e.g., larasail.yml or similar) to define the Docker containers, network settings, and other environment configurations. Users can typically customize these files to adapt LaraSail to their specific needs. Understanding the configuration file structure is key to advanced usage.
DOCKER INTEGRATION
LaraSail simplifies Docker management for Laravel projects. Commands like `up` and `down` interact directly with Docker containers, automating the process of starting and stopping the development environment. It uses docker-compose in the background.
HISTORY
LaraSail was developed to address the initial setup hurdles faced by developers new to Laravel and the Docker ecosystem. Its development is ongoing, driven by the need for faster and easier Laravel project setup.
SEE ALSO
docker(1), docker-compose(1), artisan(1)