Weave Code
Lumen Installer Laravel Package
laravel/lumen-installer
Official Laravel Lumen project installer. Provides the lumen command to quickly scaffold new Lumen applications, including recommended defaults and project structure. Install via Composer and run lumen new <app> to get started.
At a glance
Frequently asked questions about Lumen Installer
- How do I install the Lumen Installer package for Laravel projects?
- Use Composer to install it as a development dependency: `composer require laravel/lumen-installer --dev`. After installation, run `vendor/bin/lumen new <app-name>` to scaffold a new Lumen project with official defaults.
- Does this package work with Laravel applications?
- No, this package is specifically designed for **Lumen** microservices, not Laravel. It generates a Lumen skeleton and is not compatible with Laravel’s monolithic structure or dependencies.
- What Lumen version does this installer support?
- The installer is hardcoded for **Lumen 6.x** and will not work with newer or older versions. If you need a different Lumen version, consider alternatives like `composer create-project lumen/lumen` or forking this package.
- Can I customize the generated Lumen project structure?
- Limited customization is available via preset flags like `--preset=api`. However, the installer lacks a plugin system or event hooks, so extensive modifications may require forking or using a custom script.
- Is this package safe to use in production?
- No, this is a **development-only** tool for scaffolding projects. It should never be included in production deployments. Use it only during project initialization or CI/CD pipelines.
- Why should I use this instead of `composer create-project lumen/lumen`?
- This installer provides a **streamlined CLI experience** with opinionated defaults aligned with Lumen’s official documentation. It’s faster for repetitive setups and integrates seamlessly with Composer workflows.
- Does the Lumen Installer support PHP 8.x?
- No, it only supports **PHP 7.2–7.4** due to its dependency on Lumen 6.x, which reached end-of-life in 2021. If you need PHP 8.x, consider migrating to a newer Lumen version or using alternatives.
- How can I integrate this into a CI/CD pipeline like GitHub Actions?
- Add a step to install the package and scaffold the project. Example GitHub Actions snippet: `composer require laravel/lumen-installer --dev && vendor/bin/lumen new my-app --preset=api`. Ensure PHP 7.4 is used.
- What happens if the installer fails during project creation?
- If the installer fails, fall back to `composer create-project lumen/lumen` or use a custom script. Document this as a contingency in your deployment workflows, especially in CI/CD environments.
- Is there a way to extend or modify the installer’s templates?
- The installer does not support dynamic template extensions or plugins. For advanced customization, you’d need to fork the repository or build a wrapper script around `composer create-project lumen/lumen` with your own logic.
Weaver
How can I help you explore Laravel packages today?