Skip to content
United by Code

Filament Docs for AI

We can get the documentation from Filament 3.x in an AI-friendly format.

It updates daily!

There’s a file per Filament package, one MD file per package - Panels, Forms, Tables, etc.

It’s ideal for local code agents, like Claude Code, Cursor, Windsurf, etc.

By having the documentation concatenated by package, the agent get more efficient and cost saving.

Copy-paste and run this script on a root of a project, download docs into ./docs/ai/filament-3.x.

Terminal window
mkdir -p ./docs/ai/filament-3.x
curl -L https://github.com/ijpatricio/oven/releases/download/filament-docs/filament-3.x-packages-3.x.zip -o filament-temp.zip
unzip filament-temp.zip -d ./docs/ai/filament-3.x
rm filament-temp.zip
echo "Download and extraction completed successfully to ./docs/ai/filament-3.x"

If you prefer to download, here’s link

Then, in CLAUDE.md, Cursor rules, Windsurf, you let the AI know about this.

Take this a starting point, and add your instructions for your custom preferences:

# Filament Documentation Integration Rules


## Purpose
These rules define how to use the locally stored Filament documentation when working with this project.


## Documentation Structure
- Documentation is organized by package (Panels, Forms, Tables, etc.)
- Located at: `./docs/ai/filament-3.x/`
- Each package has its own markdown file with comprehensive documentation


## When to Reference Documentation
1. When implementing or modifying any Filament component
2. When troubleshooting Filament-specific issues
3. When exploring available options for a specific Filament feature
4. Before asking general questions about Filament capabilities


## How to Reference Documentation
For any Filament-related task, first check the relevant package documentation:


- For forms: `./docs/ai/filament-3.x/forms.md`
- For tables: `./docs/ai/filament-3.x/tables.md`
- For panels: `./docs/ai/filament-3.x/panels.md`
- For notifications: `./docs/ai/filament-3.x/notifications.md`
- For actions: `./docs/ai/filament-3.x/actions.md`
- For widgets: `./docs/ai/filament-3.x/widgets.md`
- For infolist: `./docs/ai/filament-3.x/infolist.md`


## Best Practices
1. Always reference the specific documentation section relevant to the current task
2. Use documentation examples as templates for implementation
3. Follow Filament's conventions and patterns as shown in documentation
4. When documentation differs from project implementation, prefer project-specific patterns

Code assistants:

That’s it. Happy coding!

An all-in-one file

There’s also an all-in-one file, if preferred. It’s ideal for Web AI crawlers standard llms.txt.