mirror of
https://github.com/filamentphp/filament.git
synced 2026-09-01 15:09:33 +08:00
AI docs
This commit is contained in:
@@ -0,0 +1,77 @@
|
||||
---
|
||||
title: AI-assisted development
|
||||
---
|
||||
|
||||
## Introduction
|
||||
|
||||
AI coding agents like [Claude Code](https://docs.anthropic.com/en/docs/claude-code), [Cursor](https://cursor.com), and [GitHub Copilot](https://github.com/features/copilot) can significantly accelerate your Filament development. Filament includes guidelines for [Laravel Boost](https://laravel.com/ai/boost) that teach AI agents how to write idiomatic Filament code and follow framework conventions.
|
||||
|
||||
## Installing Laravel Boost
|
||||
|
||||
Install Boost as a development dependency:
|
||||
|
||||
```bash
|
||||
composer require laravel/boost --dev
|
||||
```
|
||||
|
||||
Then run the interactive installer:
|
||||
|
||||
```bash
|
||||
php artisan boost:install
|
||||
```
|
||||
|
||||
The installer will detect your IDE and AI agents, generating the necessary configuration files. To verify installation, check your `AGENTS.md`, `CLAUDE.md`, or similar file for a new **Filament** section.
|
||||
|
||||
For more information about Laravel Boost, including available tools, documentation search, and IDE integration, see the [Laravel AI documentation](https://laravel.com/docs/ai).
|
||||
|
||||
## Filament Blueprint
|
||||
|
||||
The guidelines included with Boost are designed primarily for **implementing agents** - they help agents write correct Filament code once they know what to build. However, the quality of AI-generated code depends heavily on the quality of the plan. When an implementing agent has a clear, detailed specification, it can focus entirely on writing correct code rather than guessing at requirements or making assumptions about your intent.
|
||||
|
||||
For complex features, you may find that agents struggle with the planning phase: choosing the right components, structuring relationships, and anticipating edge cases. A vague plan leads to vague code, and you end up spending more time correcting the agent than you saved by using it.
|
||||
|
||||
Filament Blueprint is a paid Laravel Boost extension that teaches AI agents how to write detailed Filament implementation plans. Instead of hoping an agent understands what you want, Blueprint produces unambiguous specification documents that cover:
|
||||
|
||||
- **Models**: Attributes, casts, relationships, and enums with exact syntax
|
||||
- **Resources**: Full namespaces, scaffold commands, and configuration
|
||||
- **Forms**: Field components, validation rules, and layout structure
|
||||
- **Tables**: Columns, filters, actions, and sorting behavior
|
||||
- **Authorization**: Plain-English policy rules that translate directly to code
|
||||
- **Testing**: What to test and how to verify it works
|
||||
- **More**: Reactive fields, wizards, imports/exports, bulk actions, widgets, multi-tenancy, and more
|
||||
|
||||
The planning agent copies all necessary details into the blueprint itself, so the implementing agent has everything it needs without loading the planning guidelines. This separation keeps your implementing agent's context window focused on writing code.
|
||||
|
||||
### Installing Blueprint
|
||||
|
||||
Blueprint requires Laravel Boost. Install it via Composer:
|
||||
|
||||
```bash
|
||||
composer require filament/blueprint
|
||||
```
|
||||
|
||||
Then run the Boost installer and select **Filament Blueprint** when prompted:
|
||||
|
||||
```bash
|
||||
php artisan boost:install
|
||||
```
|
||||
|
||||
To verify installation, check your `AGENTS.md`, `CLAUDE.md`, or similar file for a new **Filament Blueprint** section.
|
||||
|
||||
### Using Blueprint
|
||||
|
||||
To create a blueprint, enable **planning mode** in your AI agent and ask it to create a Filament Blueprint for your feature:
|
||||
|
||||
```
|
||||
Create a Filament Blueprint for an order management system.
|
||||
|
||||
Orders belong to customers and have many order items. Each order has a status
|
||||
(pending, confirmed, shipped, delivered, cancelled), shipping address, and
|
||||
optional notes. Order items reference products with quantity and unit price.
|
||||
|
||||
I need to search orders by customer name and filter by status and date range.
|
||||
The order form should calculate line totals automatically as items are added.
|
||||
Only admins can delete orders, and orders can only be cancelled if not yet shipped.
|
||||
```
|
||||
|
||||
The agent will produce a detailed specification document ready for direct implementation.
|
||||
Reference in New Issue
Block a user