README

Making Production and Local development environment for Laravel apps using FrankenPHP + Laravel Octane easy. Zero configuration required.

⚠️ Beta: This project is in BETA — APIs, file layout, and packages may change. Use for prototyping and early development. Report bugs or breaking changes in issues, please.

What this package provides

A lira CLI wrapper (mirroring Laravel Sail) with grouped commands for Docker, shell access, tooling, and network
A multi-stage Docker build: Composer vendor, Vite frontend, and a FrankenPHP + PHP 8.4 + Caddy runtime
Three container roles out of the box — web, worker, and scheduler — controlled by CONTAINER_MODE
Publishable docker/ directory for full local customisation without losing upstream updates
Local HTTPS via Caddy with a one-command OS trust store installer
/etc/hosts management for custom local domains
A health command showing service status, site reachability, and recent logs

Quick start

Install the package with Composer:

composer require liraui/deployer

Add the shell alias to your ~/.zshrc or ~/.bashrc:

alias lira='sh $([ -f lira ] && echo lira || echo vendor/bin/lira)'

Start the stack:

lira up

For full installation instructions and documentation, visit the Installation guide.

Commands

Docker
  up                      Start all containers (detached)
  down [-v] [--rmi]       Stop containers; -v removes volumes, --rmi removes images
  health                  Show service status, site reachability, and recent logs
  clean                   Full teardown: containers, volumes, images, SSL
  publish [--force]       Copy Docker files to docker/ for local customisation

Shell
  shell                   Open an interactive shell (/bin/sh)
  tinker                  Open a Laravel Tinker REPL

Tooling
  artisan <args...>       Run php artisan in the app container
  composer <args...>      Run composer in the app container
  npm <args...>           Run npm on the host
  npx <args...>           Run npx on the host

Network
  dns <add|remove|status> Manage /etc/hosts for APP_DOMAIN
  trust-ca                Install Caddy local CA into the OS trust store
  untrust-ca              Remove Caddy local CA from the OS trust store

Contributing

Bug reports and contributions are welcome — please open an issue or a pull request. Maintain a short description of breaking changes.

License

The deployer package is open-sourced licensed under the MIT license.

liraui / deployer

Maintainers

Package info

Statistics

Security