Boost Spatie Guidelines
Spatie's Laravel & PHP coding guidelines for Laravel Boost
#Spatie Guidelines for Laravel Boost
Bring Spatie's battle-tested Laravel & PHP coding guidelines to your AI-assisted development workflow with Laravel Boost.
#Installation
Install the package via Composer:
composer require spatie/boost-spatie-guidelines --dev
Then install the guidelines with Boost:
php artisan boost:install
Select the Spatie guidelines from the list and they'll be installed to .ai/guidelines/boost-spatie-guidelines/.
#What's Included
This package provides AI-optimized versions of Spatie's Laravel & PHP coding standards, including:
- PSR compliance (PSR-1, PSR-2, PSR-12)
- Type declarations and nullable syntax
- Class structure and property promotion
- Control flow patterns (happy path, early returns)
- Laravel conventions (routes, controllers, configuration)
- Naming conventions (camelCase, kebab-case, snake_case)
- Blade templates and validation
- Testing best practices
These guidelines help AI assistants like Claude Code generate code that follows Spatie's proven standards.
#Support us
We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.
#Usage
Once installed, AI assistants using Laravel Boost will automatically reference these guidelines when generating code. No additional configuration needed!
#Keeping Guidelines Up to Date
Re-run the Boost installer after updating the package to refresh guidelines:
composer update spatie/boost-spatie-guidelines php artisan boost:update
#Full Guidelines
View the complete, human-readable guidelines at spatie.be/guidelines.
#Changelog
Please see CHANGELOG for recent changes.
#Contributing
Please see CONTRIBUTING for details.
#Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
#Postcardware
You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.
Our address is: Spatie, Kruikstraat 22, 2018 Antwerp, Belgium.
We publish all received postcards on our company website.
#Credits
#License
The MIT License (MIT). Please see License File for more information.
