Weave Code
Spark Installer Laravel Package
laravel/spark-installer
Command-line installer for Laravel Spark. Clone and composer install, add to PATH, then register with your Spark API token. Use spark new to scaffold a new Spark project and run migrations to finish setup.
At a glance
Frequently asked questions about Spark Installer
- What Laravel versions does the Spark Installer support?
- The installer is designed for Laravel 5.5–5.8, matching Spark’s original compatibility range. If you’re using Laravel 9.x or newer, you’ll need to manually adapt Spark’s codebase or evaluate alternatives like Laravel Cashier + Jetstream, as Spark itself is deprecated for modern Laravel.
- How do I add the `spark` CLI tool to my system PATH?
- After cloning the repository and running `composer install`, locate the directory containing the `spark` executable (usually `vendor/bin/spark`). Add this path to your system’s PATH environment variable. On Linux/macOS, edit `~/.bashrc` or `~/.zshrc`; on Windows, use System Properties > Environment Variables.
- Can I use this installer for existing Laravel projects, or only new ones?
- The installer is primarily for bootstrapping *new* Spark projects. For existing projects, you’ll need to manually merge Spark’s dependencies (e.g., migrations, middleware) and resolve conflicts like duplicate `users` tables or auth systems. Test thoroughly, as Spark’s migrations assume a clean database.
- What happens if my Spark license token expires or changes?
- If your Spark license token expires or is revoked, you’ll need to re-register the installer with the new token using `spark register <new-token>`. The installer doesn’t cache tokens, so you must re-authenticate. Ensure your team has access to the latest token to avoid project generation failures.
- Does the installer work with custom Spark plugins or modifications?
- No, the installer assumes a vanilla Spark installation. Custom plugins or modified Spark files (e.g., altered Blade views or middleware) won’t be included. You’d need to manually integrate these post-installation or fork the installer to support your changes.
- Will this installer conflict with Laravel Jetstream or Breeze?
- Yes, Spark and Jetstream/Breeze overlap in features like authentication and team management. Spark’s installer will add its own migrations, middleware, and Blade components, which may conflict with Jetstream’s `users` table or auth scaffolding. Evaluate your needs: Spark for SaaS billing, Jetstream for simpler auth.
- How do I handle database migrations after running `spark new`?
- After generating a project with `spark new project-name`, navigate to the project directory and run `php artisan migrate` to set up Spark’s database tables (e.g., `spark_users`, `teams`). If you’re integrating with an existing project, review Spark’s migrations first to avoid conflicts with your current schema.
- Is there a way to use this installer without a Spark license?
- No, the installer requires a valid Spark license token for registration (`spark register`). Without one, you cannot generate new projects. If licensing is a concern, consider alternatives like Laravel Cashier (for billing) paired with Jetstream (for auth), which are open-source and don’t require a paid license.
- Can I generate Spark projects in a specific directory instead of the default?
- The `spark new` command creates projects in the current working directory by default. To specify a custom path, navigate to your desired directory before running the command or use a symbolic link to redirect the output. There’s no built-in flag for direct path specification.
- What should I do if the installer fails due to Laravel/Spark updates?
- Since the installer is unmaintained (last release in 2020), failures may occur due to Laravel or Spark changes. Check the [GitHub issues](https://github.com/laravel/spark-installer/issues) for patches, or manually update the installer’s dependencies (e.g., `composer update`). For critical projects, consider forking the repo or migrating to modern alternatives like Laravel Cashier + Jetstream.
Weaver
How can I help you explore Laravel packages today?