Skip to content

Commit ae17084

Browse files
committed
chore: setup boost
1 parent b41c98d commit ae17084

File tree

6 files changed

+783
-40
lines changed

6 files changed

+783
-40
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,6 @@ yarn-error.log
2121
/.nova
2222
/.vscode
2323
/.zed
24+
.mcp.json
25+
.claude/*
26+
.codex/*

AGENTS.md

Lines changed: 281 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,281 @@
1+
<laravel-boost-guidelines>
2+
=== foundation rules ===
3+
4+
# Laravel Boost Guidelines
5+
6+
The Laravel Boost guidelines are specifically curated by Laravel maintainers for this application. These guidelines should be followed closely to ensure the best experience when building Laravel applications.
7+
8+
## Foundational Context
9+
10+
This application is a Laravel application and its main Laravel ecosystems package & versions are below. You are an expert with them all. Ensure you abide by these specific packages & versions.
11+
12+
- php - 8.4.17
13+
- laravel/framework (LARAVEL) - v12
14+
- laravel/prompts (PROMPTS) - v0
15+
- livewire/flux (FLUXUI_FREE) - v2
16+
- livewire/livewire (LIVEWIRE) - v4
17+
- larastan/larastan (LARASTAN) - v3
18+
- laravel/mcp (MCP) - v0
19+
- laravel/pint (PINT) - v1
20+
- laravel/sail (SAIL) - v1
21+
- pestphp/pest (PEST) - v4
22+
- phpunit/phpunit (PHPUNIT) - v12
23+
- rector/rector (RECTOR) - v2
24+
- prettier (PRETTIER) - v3
25+
- tailwindcss (TAILWINDCSS) - v4
26+
27+
## Skills Activation
28+
29+
This project has domain-specific skills available. You MUST activate the relevant skill whenever you work in that domain—don't wait until you're stuck.
30+
31+
- `fluxui-development` — Develops UIs with Flux UI Free components. Activates when creating buttons, forms, modals, inputs, dropdowns, checkboxes, or UI components; replacing HTML form elements with Flux; working with flux: components; or when the user mentions Flux, component library, UI components, form fields, or asks about available Flux components.
32+
- `livewire-development` — Develops reactive Livewire 4 components. Activates when creating, updating, or modifying Livewire components; working with wire:model, wire:click, wire:loading, or any wire: directives; adding real-time updates, loading states, or reactivity; debugging component behavior; writing Livewire tests; or when the user mentions Livewire, component, counter, or reactive UI.
33+
- `pest-testing` — Tests applications using the Pest 4 PHP framework. Activates when writing tests, creating unit or feature tests, adding assertions, testing Livewire components, browser testing, debugging test failures, working with datasets or mocking; or when the user mentions test, spec, TDD, expects, assertion, coverage, or needs to verify functionality works.
34+
- `tailwindcss-development` — Styles applications using Tailwind CSS v4 utilities. Activates when adding styles, restyling components, working with gradients, spacing, layout, flex, grid, responsive design, dark mode, colors, typography, or borders; or when the user mentions CSS, styling, classes, Tailwind, restyle, hero section, cards, buttons, or any visual/UI changes.
35+
- `developing-with-prism` — Guide for developing with Prism PHP package - a Laravel package for integrating LLMs. Activate or use when working with Prism features including text generation, structured output, embeddings, image generation, audio processing, streaming, tools/function calling, or any LLM provider integration (OpenAI, Anthropic, Gemini, Mistral, Groq, XAI, DeepSeek, OpenRouter, Ollama, VoyageAI, ElevenLabs). Activate for any Prism-related development tasks.
36+
37+
## Conventions
38+
39+
- You must follow all existing code conventions used in this application. When creating or editing a file, check sibling files for the correct structure, approach, and naming.
40+
- Use descriptive names for variables and methods. For example, `isRegisteredForDiscounts`, not `discount()`.
41+
- Check for existing components to reuse before writing a new one.
42+
43+
## Verification Scripts
44+
45+
- Do not create verification scripts or tinker when tests cover that functionality and prove they work. Unit and feature tests are more important.
46+
47+
## Application Structure & Architecture
48+
49+
- Stick to existing directory structure; don't create new base folders without approval.
50+
- Do not change the application's dependencies without approval.
51+
52+
## Frontend Bundling
53+
54+
- If the user doesn't see a frontend change reflected in the UI, it could mean they need to run `npm run build`, `npm run dev`, or `composer run dev`. Ask them.
55+
56+
## Documentation Files
57+
58+
- You must only create documentation files if explicitly requested by the user.
59+
60+
## Replies
61+
62+
- Be concise in your explanations - focus on what's important rather than explaining obvious details.
63+
64+
=== boost rules ===
65+
66+
# Laravel Boost
67+
68+
- Laravel Boost is an MCP server that comes with powerful tools designed specifically for this application. Use them.
69+
70+
## Artisan
71+
72+
- Use the `list-artisan-commands` tool when you need to call an Artisan command to double-check the available parameters.
73+
74+
## URLs
75+
76+
- Whenever you share a project URL with the user, you should use the `get-absolute-url` tool to ensure you're using the correct scheme, domain/IP, and port.
77+
78+
## Tinker / Debugging
79+
80+
- You should use the `tinker` tool when you need to execute PHP to debug code or query Eloquent models directly.
81+
- Use the `database-query` tool when you only need to read from the database.
82+
83+
## Reading Browser Logs With the `browser-logs` Tool
84+
85+
- You can read browser logs, errors, and exceptions using the `browser-logs` tool from Boost.
86+
- Only recent browser logs will be useful - ignore old logs.
87+
88+
## Searching Documentation (Critically Important)
89+
90+
- Boost comes with a powerful `search-docs` tool you should use before trying other approaches when working with Laravel or Laravel ecosystem packages. This tool automatically passes a list of installed packages and their versions to the remote Boost API, so it returns only version-specific documentation for the user's circumstance. You should pass an array of packages to filter on if you know you need docs for particular packages.
91+
- Search the documentation before making code changes to ensure we are taking the correct approach.
92+
- Use multiple, broad, simple, topic-based queries at once. For example: `['rate limiting', 'routing rate limiting', 'routing']`. The most relevant results will be returned first.
93+
- Do not add package names to queries; package information is already shared. For example, use `test resource table`, not `filament 4 test resource table`.
94+
95+
### Available Search Syntax
96+
97+
1. Simple Word Searches with auto-stemming - query=authentication - finds 'authenticate' and 'auth'.
98+
2. Multiple Words (AND Logic) - query=rate limit - finds knowledge containing both "rate" AND "limit".
99+
3. Quoted Phrases (Exact Position) - query="infinite scroll" - words must be adjacent and in that order.
100+
4. Mixed Queries - query=middleware "rate limit" - "middleware" AND exact phrase "rate limit".
101+
5. Multiple Queries - queries=["authentication", "middleware"] - ANY of these terms.
102+
103+
=== php rules ===
104+
105+
# PHP
106+
107+
- Always use curly braces for control structures, even for single-line bodies.
108+
109+
## Constructors
110+
111+
- Use PHP 8 constructor property promotion in `__construct()`.
112+
- <code-snippet>public function __construct(public GitHub $github) { }</code-snippet>
113+
- Do not allow empty `__construct()` methods with zero parameters unless the constructor is private.
114+
115+
## Type Declarations
116+
117+
- Always use explicit return type declarations for methods and functions.
118+
- Use appropriate PHP type hints for method parameters.
119+
120+
<code-snippet name="Explicit Return Types and Method Params" lang="php">
121+
protected function isAccessible(User $user, ?string $path = null): bool
122+
{
123+
...
124+
}
125+
</code-snippet>
126+
127+
## Enums
128+
129+
- Typically, keys in an Enum should be TitleCase. For example: `FavoritePerson`, `BestLake`, `Monthly`.
130+
131+
## Comments
132+
133+
- Prefer PHPDoc blocks over inline comments. Never use comments within the code itself unless the logic is exceptionally complex.
134+
135+
## PHPDoc Blocks
136+
137+
- Add useful array shape type definitions when appropriate.
138+
139+
=== herd rules ===
140+
141+
# Laravel Herd
142+
143+
- The application is served by Laravel Herd and will be available at: `https?://[kebab-case-project-dir].test`. Use the `get-absolute-url` tool to generate valid URLs for the user.
144+
- You must not run any commands to make the site available via HTTP(S). It is always available through Laravel Herd.
145+
146+
=== tests rules ===
147+
148+
# Test Enforcement
149+
150+
- Every change must be programmatically tested. Write a new test or update an existing test, then run the affected tests to make sure they pass.
151+
- Run the minimum number of tests needed to ensure code quality and speed. Use `php artisan test --compact` with a specific filename or filter.
152+
153+
=== laravel/core rules ===
154+
155+
# Do Things the Laravel Way
156+
157+
- Use `php artisan make:` commands to create new files (i.e. migrations, controllers, models, etc.). You can list available Artisan commands using the `list-artisan-commands` tool.
158+
- If you're creating a generic PHP class, use `php artisan make:class`.
159+
- Pass `--no-interaction` to all Artisan commands to ensure they work without user input. You should also pass the correct `--options` to ensure correct behavior.
160+
161+
## Database
162+
163+
- Always use proper Eloquent relationship methods with return type hints. Prefer relationship methods over raw queries or manual joins.
164+
- Use Eloquent models and relationships before suggesting raw database queries.
165+
- Avoid `DB::`; prefer `Model::query()`. Generate code that leverages Laravel's ORM capabilities rather than bypassing them.
166+
- Generate code that prevents N+1 query problems by using eager loading.
167+
- Use Laravel's query builder for very complex database operations.
168+
169+
### Model Creation
170+
171+
- When creating new models, create useful factories and seeders for them too. Ask the user if they need any other things, using `list-artisan-commands` to check the available options to `php artisan make:model`.
172+
173+
### APIs & Eloquent Resources
174+
175+
- For APIs, default to using Eloquent API Resources and API versioning unless existing API routes do not, then you should follow existing application convention.
176+
177+
## Controllers & Validation
178+
179+
- Always create Form Request classes for validation rather than inline validation in controllers. Include both validation rules and custom error messages.
180+
- Check sibling Form Requests to see if the application uses array or string based validation rules.
181+
182+
## Authentication & Authorization
183+
184+
- Use Laravel's built-in authentication and authorization features (gates, policies, Sanctum, etc.).
185+
186+
## URL Generation
187+
188+
- When generating links to other pages, prefer named routes and the `route()` function.
189+
190+
## Queues
191+
192+
- Use queued jobs for time-consuming operations with the `ShouldQueue` interface.
193+
194+
## Configuration
195+
196+
- Use environment variables only in configuration files - never use the `env()` function directly outside of config files. Always use `config('app.name')`, not `env('APP_NAME')`.
197+
198+
## Testing
199+
200+
- When creating models for tests, use the factories for the models. Check if the factory has custom states that can be used before manually setting up the model.
201+
- Faker: Use methods such as `$this->faker->word()` or `fake()->randomDigit()`. Follow existing conventions whether to use `$this->faker` or `fake()`.
202+
- When creating tests, make use of `php artisan make:test [options] {name}` to create a feature test, and pass `--unit` to create a unit test. Most tests should be feature tests.
203+
204+
## Vite Error
205+
206+
- If you receive an "Illuminate\Foundation\ViteException: Unable to locate file in Vite manifest" error, you can run `npm run build` or ask the user to run `npm run dev` or `composer run dev`.
207+
208+
=== laravel/v12 rules ===
209+
210+
# Laravel 12
211+
212+
- CRITICAL: ALWAYS use `search-docs` tool for version-specific Laravel documentation and updated code examples.
213+
- Since Laravel 11, Laravel has a new streamlined file structure which this project uses.
214+
215+
## Laravel 12 Structure
216+
217+
- In Laravel 12, middleware are no longer registered in `app/Http/Kernel.php`.
218+
- Middleware are configured declaratively in `bootstrap/app.php` using `Application::configure()->withMiddleware()`.
219+
- `bootstrap/app.php` is the file to register middleware, exceptions, and routing files.
220+
- `bootstrap/providers.php` contains application specific service providers.
221+
- The `app\Console\Kernel.php` file no longer exists; use `bootstrap/app.php` or `routes/console.php` for console configuration.
222+
- Console commands in `app/Console/Commands/` are automatically available and do not require manual registration.
223+
224+
## Database
225+
226+
- When modifying a column, the migration must include all of the attributes that were previously defined on the column. Otherwise, they will be dropped and lost.
227+
- Laravel 12 allows limiting eagerly loaded records natively, without external packages: `$query->latest()->limit(10);`.
228+
229+
### Models
230+
231+
- Casts can and likely should be set in a `casts()` method on a model rather than the `$casts` property. Follow existing conventions from other models.
232+
233+
=== fluxui-free/core rules ===
234+
235+
# Flux UI Free
236+
237+
- Flux UI is the official Livewire component library. This project uses the free edition, which includes all free components and variants but not Pro components.
238+
- Use `<flux:*>` components when available; they are the recommended way to build Livewire interfaces.
239+
- IMPORTANT: Activate `fluxui-development` when working with Flux UI components.
240+
241+
=== livewire/core rules ===
242+
243+
# Livewire
244+
245+
- Livewire allows you to build dynamic, reactive interfaces using only PHP — no JavaScript required.
246+
- Instead of writing frontend code in JavaScript frameworks, you use Alpine.js to build the UI when client-side interactions are required.
247+
- State lives on the server; the UI reflects it. Validate and authorize in actions (they're like HTTP requests).
248+
- IMPORTANT: Activate `livewire-development` every time you're working with Livewire-related tasks.
249+
250+
=== pint/core rules ===
251+
252+
# Laravel Pint Code Formatter
253+
254+
- You must run `vendor/bin/pint --dirty --format agent` before finalizing changes to ensure your code matches the project's expected style.
255+
- Do not run `vendor/bin/pint --test --format agent`, simply run `vendor/bin/pint --format agent` to fix any formatting issues.
256+
257+
=== pest/core rules ===
258+
259+
## Pest
260+
261+
- This project uses Pest for testing. Create tests: `php artisan make:test --pest {name}`.
262+
- Run tests: `php artisan test --compact` or filter: `php artisan test --compact --filter=testName`.
263+
- Do NOT delete tests without approval.
264+
- CRITICAL: ALWAYS use `search-docs` tool for version-specific Pest documentation and updated code examples.
265+
- IMPORTANT: Activate `pest-testing` every time you're working with a Pest or testing-related task.
266+
267+
=== tailwindcss/core rules ===
268+
269+
# Tailwind CSS
270+
271+
- Always use existing Tailwind conventions; check project patterns before adding new ones.
272+
- IMPORTANT: Always use `search-docs` tool for version-specific Tailwind CSS documentation and updated code examples. Never rely on training data.
273+
- IMPORTANT: Activate `tailwindcss-development` every time you're working with a Tailwind CSS or styling-related task.
274+
275+
=== prism-php/prism rules ===
276+
277+
## Prism
278+
279+
- Prism is a Laravel package for integrating Large Language Models (LLMs) into applications with a fluent, expressive and eloquent API.
280+
- IMPORTANT: Activate `developing-with-prism` skill when working with Prism features.
281+
</laravel-boost-guidelines>

0 commit comments

Comments
 (0)