README

Comprehensive documentation for Filament v5, designed for LLMs and AI-assisted development.

Installation

This package requires laravel/boost. Install as a dev dependency:

composer require aldesrahim/filament-compass --dev

Then run the Boost installer — Filament Compass will appear as an available third-party package:

php artisan boost:install

Usage

Filament Compass provides Filament v5 guidelines and skills for laravel/boost, optimized for LLMs and AI-assisted development. Once installed via boost:install, your AI agents will have access to comprehensive Filament v5 documentation.

Working with AI Assistants (Claude Code, Cursor, etc.)

When starting a Filament-related task, always instruct your AI assistant to load the filament-compass skill before proceeding. This ensures the AI has access to accurate Filament v5 documentation and follows the correct patterns.

Example prompt:

Load the filament-compass skill, then help me create a Filament resource for the `Order` model with a table that shows id, customer name, status, and total amount, and a form with all the necessary fields.

Recommended

Pair this package with filacheck for the best AI-assisted Filament development experience.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Al Desrahim
• All Contributors

License

The MIT License (MIT). Please see License File for more information.