You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+42Lines changed: 42 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -81,6 +81,25 @@ Laravel Boost includes AI guidelines for the following packages and frameworks.
81
81
| Laravel Folio | core |
82
82
| Enforce Tests | conditional |
83
83
84
+
### Keeping Guidelines Up-to-Date
85
+
86
+
You may want to periodically update your local AI guidelines to ensure they reflect the latest versions of the Laravel ecosystem packages you have installed. To do so, you can use the `boost:update` Artisan command.
87
+
88
+
```bash
89
+
php artisan boost:update
90
+
```
91
+
92
+
You may also automate this process by adding it to your Composer "post-update-cmd" scripts:
93
+
94
+
```json
95
+
{
96
+
"scripts": {
97
+
"post-update-cmd": [
98
+
"@php artisan boost:update --ansi"
99
+
]
100
+
}
101
+
}
102
+
```
84
103
85
104
## Available Documentation
86
105
@@ -106,6 +125,29 @@ You can override Boost's built-in AI guidelines by creating your own custom guid
106
125
107
126
For example, to override Boost's "Inertia React v2 Form Guidance" guidelines, create a file at `.ai/guidelines/inertia-react/2/forms.blade.php`. When you run `boost:install`, Boost will include your custom guideline instead of the default one.
108
127
128
+
## Third-Party Package AI Guidelines
129
+
130
+
If you maintain a third-party package and would like Boost to include AI guidelines for it, you can do so by adding a `resources/boost/guidelines/core.blade.php` file to your package. When users of your package run `php artisan boost:install`, Boost will automatically load your guidelines.
131
+
132
+
AI guidelines should provide a short overview of what your package does, outline any required file structure or conventions, and explain how to create or use its main features (with example commands or code snippets). Keep them concise, actionable, and focused on best practices so AI can generate correct code for your users. Here is an example:
133
+
134
+
```php
135
+
## Package Name
136
+
137
+
This package provides [brief description of functionality].
138
+
139
+
### Features
140
+
141
+
- Feature 1: [clear & short description].
142
+
- Feature 2: [clear & short description]. Example usage:
143
+
144
+
@verbatim
145
+
<code-snippetname="How to use Feature 2"lang="php">
Sometimes you may need to manually register the Laravel Boost MCP server with your editor of choice. You should register the MCP server using the following details:
0 commit comments