AGENTS.md
AGENTS.md for Laravel
AGENTS.md is a plain markdown file at the root of a repo. Coding agents from Cursor, Codex, Copilot, and others read it before they edit. This copy is written for a Laravel project. This repository is a Laravel application. Routes stay thin, Eloquent owns persistence, and schema changes go through migrations. Use Artisan for the commands the repo already expects.
The example uses a balanced, readable style, pragmatic tests, and comments only where the intent is not obvious. Open the generator to make the agent stricter, switch to test-first, quiet the comments, or pick a different file.
The example assumes Laravel with Eloquent and migrations. It does not assume Inertia, Livewire, or a particular admin package. If the repo uses one of those, follow it instead of adding a second UI stack.
Example file
Balanced strictness, readable style, pragmatic tests. Download name: AGENTS.md
# AGENTS.md
Instructions for coding agents working in this Laravel repository. Cursor, Claude Code, Codex, Copilot, and other agents should follow this file before they guess.
## Stack
This repository is a Laravel application. Routes stay thin, Eloquent owns persistence, and schema changes go through migrations. Use Artisan for the commands the repo already expects.
## Layout
- HTTP entry points live in routes and controllers. Non-trivial rules live in actions, models, or domain classes.
- Form requests validate input. Policies and gates authorize it.
- Database changes ship as migrations. Do not edit a migration that has already run in production.
## Commands
- Dev server: `php artisan serve`
- Tests: `php artisan test`
- Migrate: `php artisan migrate`
Use the script the repo already defines when it differs from the command above.
## Conventions
- Use Eloquent and query scopes. Reach for the query builder only when the ORM cannot say it.
- Validate with a Form Request. Do not read `$request->all()` and hope.
- Authorize with a policy or gate in the same change as the route.
- Queue slow work. Do not send mail or call a third party inside the request if the project already uses jobs.
- Match Pest or PHPUnit, whichever the repo already uses.
- Keep secrets in `.env`. Do not commit `.env` or dump config with secrets into git.
## Testing
Add or update tests when behavior changes.
Cover the Form Request or the action with the repo's Pest or PHPUnit suite. Include one rejection and one success.
## Style
- Optimize for the next reader over the shortest diff.
- Comment only when the why is non-obvious.
- Name things the way neighboring files already do.
- Do not reformat code you did not change.
## Errors
- Fail at the boundary. Do not swallow errors.
- Throw or return a validation error for bad input. Let unexpected exceptions hit the project's exception handler.
## Scope
- Do the requested task. Do not refactor unrelated code.
- Match the rigor already in the repo. Fix what you touch.
- Ask one clarifying question only when the task cannot be finished without it. Otherwise state the assumption and continue.
## Avoid
- Do not call `env()` outside config files. Use `config()` after the config is cached.
- Do not hide N+1 queries. Eager load relations the response actually walks.
- Do not skip authorization because the route is behind `auth`.
- Do not rewrite a vendor class. Use a container binding or an event the framework already fires.
## Done when
- The requested behavior works.
- `php artisan test` passes, and a new migration is included when the schema changed.
- The diff stays inside the task.
- You list anything you could not run.
Add it to the project
01
Copy a starting file
Copy the example AGENTS.md on this page, or open the generator if you want different testing, strictness, or comment rules.
02
Save it at AGENTS.md
Save it as `AGENTS.md` at the root of the Laravel repo. A nested AGENTS.md can override these rules inside one directory later.
03
Start a fresh agent session
Rules files are read when a session starts. A chat that is already open may still be using the old instructions.
04
Give it one small task
Ask for one change a Laravel agent often gets wrong, such as a form request that rejects a bad payload before the controller runs. If it ignores the file, confirm the path and start a new session.
Questions about this file
Where do I put AGENTS.md in a Laravel repo?
Save it as `AGENTS.md` at the root of the Laravel repo. A nested AGENTS.md can override these rules inside one directory later.
Which tools read this AGENTS.md?
AGENTS.md is the shared file. Cursor, OpenAI Codex, and a growing set of coding agents read it from the repository root. Nested copies can narrow the rules for one folder.
What does the Laravel example assume?
The example assumes Laravel with Eloquent and migrations. It does not assume Inertia, Livewire, or a particular admin package. If the repo uses one of those, follow it instead of adding a second UI stack.
Does VibeSpell upload my repository?
No. Recipe pages are static, and the generator builds the file in your browser from the options you pick. Your source code never leaves the machine.
Other files for Laravel
Cursor rules
.cursor/rules/project.mdc
CLAUDE.md
CLAUDE.md
system prompt
system-prompt.md
Copilot instructions
.github/copilot-instructions.md
Windsurf rules
.windsurf/rules/project.md
Cline rules
.clinerules
GEMINI.md
GEMINI.md
Cursor testing rule
.cursor/rules/testing.mdc
Cursor security rule
.cursor/rules/security.mdc
AGENTS.md for other stacks
- AGENTS.md for Next.js
- AGENTS.md for React
- AGENTS.md for Vue
- AGENTS.md for SvelteKit
- AGENTS.md for Node.js
- AGENTS.md for FastAPI
- AGENTS.md for Django
- AGENTS.md for Go
- AGENTS.md for Rust
- AGENTS.md for Unity
- AGENTS.md for Godot
- AGENTS.md for Rails
- AGENTS.md for Flutter
- AGENTS.md for Swift
- AGENTS.md for Kotlin
- AGENTS.md for Unreal
- AGENTS.md for Next.js + Supabase
- AGENTS.md for T3
- AGENTS.md for Astro
- AGENTS.md for Remix
- AGENTS.md for Nuxt
- AGENTS.md for Electron
- AGENTS.md for Tauri
- AGENTS.md for Expo
- AGENTS.md for Spring Boot
- AGENTS.md for .NET
- AGENTS.md for Phaser
- AGENTS.md for Bevy
- AGENTS.md for Roblox
- AGENTS.md for Python ML
- AGENTS.md for LangChain