LARAVEL AGENTS.MD

A Laravel application. The rules steer an agent to the framework features that keep Laravel apps safe and consistent: Artisan generators, form requests, policies and Eloquent relationships loaded eagerly.

Zero retention: everything you type stays in this browser. Verify it yourself in DevTools.
AGENTS.mdFor Codex, Cursor, Copilot, Jules, Windsurf and more
# AGENTS.md

Project: laravel-app. A Laravel web application with MySQL.

This file is the single source of truth for every coding agent working in this repository. The tool-specific files (CLAUDE.md, GEMINI.md, .github/copilot-instructions.md and .cursor/rules/project.mdc) point here. Edit this file, not those.

## Stack

- Language: PHP
- Framework: Laravel
- Database: MySQL / MariaDB
- Hosting: AWS
- Tests: Pest
- Package manager: Composer

## Commands

Run these from the repository root.

- Install dependencies: `composer install`
- Run locally: `composer run dev`
- Build: `npm run build`
- Run all tests: `php artisan test`
- Run one test file: `php artisan test --filter=UserRegistrationTest`
- Lint: `vendor/bin/pint --test`
- Type-check: `vendor/bin/phpstan analyse`
- Format: `vendor/bin/pint`

## Project layout

- `app/Models/`: Eloquent models
- `app/Http/Controllers/`: Controllers
- `app/Http/Requests/`: Form request validation classes
- `app/Policies/`: Authorization policies
- `database/migrations/`: Migrations
- `routes/`: web.php and api.php route files
- `tests/`: Pest feature and unit tests

## Code style

- Indent with 4 spaces. Never tabs.
- Match the style and patterns of the surrounding code, even where you would personally choose differently.
- Prefer small pure functions and immutable data; keep side effects at the edges (handlers, jobs, I/O modules).
- Never swallow an error. Handle it where you can act on it, or rethrow it with context about what failed.
- Commit messages follow Conventional Commits: `feat:`, `fix:`, `refactor:`, `test:`, `docs:`, `chore:`, with an imperative summary under 72 characters.

## Working rules

- Before you say a task is done, run the test, lint and type-check commands above and make sure they pass. If you could not run them, say so.
- For a bug fix or behavior change, first write or update a test that fails, then make it pass.
- Never write secrets, API keys, tokens or passwords into code, tests, fixtures, logs or commits. Read them from environment variables, and never commit `.env` files.
- Do not add a new dependency without asking first. Prefer the standard library and what is already installed.
- Ask before creating, editing or running database migrations, and never edit a migration that has already been applied.
- Change only what the task needs. Do not refactor, rename or reformat unrelated code.

## Product constraints

- Validate all input at the boundary, use parameterized queries only, and treat every external payload as untrusted.

## Project-specific notes

- Create classes with `php artisan make:*` (model, migration, controller, request, policy, test) so names and locations follow convention.
- Validate input in Form Request classes, not inline in controllers.
- Authorize with policies and `$this->authorize()` or `can` middleware for every action on a record.
- Define `$fillable` on models; never use `$guarded = []`.
- Eager-load relationships with `with()` in list queries; never query inside Blade loops.
- Read configuration with `config()`; `env()` is only used inside `config/*.php` files, because it returns null once config is cached.
- Use the query builder or Eloquent bindings; never interpolate input into `DB::raw` or `whereRaw`.

## Project phase

This project is in active development. Follow the patterns that already exist; consistency beats novelty.
CLAUDE.mdFor Claude Code
# CLAUDE.md

@AGENTS.md

## Claude Code

- The shared project instructions are imported from AGENTS.md on the line above. Edit AGENTS.md, not this file, so every agent stays in sync.
- Put Claude-only preferences below this line. Personal, uncommitted notes belong in CLAUDE.local.md.
GEMINI.mdFor Gemini CLI
# GEMINI.md

@./AGENTS.md

## Gemini CLI

- The shared project instructions are imported from AGENTS.md on the line above. Edit AGENTS.md, not this file.
- Alternative: delete this file and set "context": { "fileName": ["AGENTS.md"] } in .gemini/settings.json so Gemini CLI reads AGENTS.md directly.
.github/copilot-instructions.mdFor GitHub Copilot
# Copilot instructions

Project: laravel-app. A Laravel web application with MySQL.

The full instructions are in AGENTS.md at the repository root. Read it before you change code; if anything here disagrees with it, AGENTS.md wins. The essentials are repeated below for Copilot surfaces that only read this file.

## Stack

- Language: PHP
- Framework: Laravel
- Database: MySQL / MariaDB
- Hosting: AWS
- Tests: Pest
- Package manager: Composer

## Commands

- Install dependencies: `composer install`
- Run locally: `composer run dev`
- Build: `npm run build`
- Run all tests: `php artisan test`
- Run one test file: `php artisan test --filter=UserRegistrationTest`
- Lint: `vendor/bin/pint --test`
- Type-check: `vendor/bin/phpstan analyse`
- Format: `vendor/bin/pint`

## Working rules

- Before you say a task is done, run the test, lint and type-check commands above and make sure they pass. If you could not run them, say so.
- For a bug fix or behavior change, first write or update a test that fails, then make it pass.
- Never write secrets, API keys, tokens or passwords into code, tests, fixtures, logs or commits. Read them from environment variables, and never commit `.env` files.
- Do not add a new dependency without asking first. Prefer the standard library and what is already installed.
- Ask before creating, editing or running database migrations, and never edit a migration that has already been applied.
- Change only what the task needs. Do not refactor, rename or reformat unrelated code.
.cursor/rules/project.mdcFor Cursor
---
description: Project instructions for every task (mirrors AGENTS.md)
globs:
alwaysApply: true
---

# Project rules

The project instructions live in @AGENTS.md at the repository root, which Cursor loads automatically. They are not repeated here, so they cost context only once. Edit AGENTS.md, not this rule.

Before you change code, check the Commands and Working rules sections of AGENTS.md, and run its test and lint commands before you say a task is done.

Put Cursor-only rules below, or add scoped rules as more .mdc files with `globs` (for example `src/components/**/*.tsx`).

These are the exact files the generator writes for this preset. Change any command or rule in the generator and download your own set.

About the Laravel preset

What Is in the Laravel AGENTS.md?

The preset describes a a Laravel web application with MySQL. Its AGENTS.md is 53 non-empty lines with 8 exact commands, 7 key directories, and 7 stack-specific rules on top of the shared working rules.

  • Commands: composer install, composer run dev, npm run build, php artisan test, php artisan test --filter=UserRegistrationTest, vendor/bin/pint --test, vendor/bin/phpstan analyse, vendor/bin/pint.
  • Layout: app/Models/, app/Http/Controllers/, app/Http/Requests/, app/Policies/, database/migrations/, routes/, tests/.
  • Wrappers: CLAUDE.md and GEMINI.md import AGENTS.md; the Copilot file repeats the essentials; the Cursor rule points to AGENTS.md.

Why These Rules for Laravel?

env() outside config breaks in production

After php artisan config:cache, calls to env() outside config files return null. Agents use env() everywhere because it works locally, and production silently loses settings.

Mass assignment

$guarded = [] makes every column writable from a request. Agents set it to fix a MassAssignmentException in one step; $fillable is the safe fix.

Policies keep authorization in one place

Scattered if ($user->id === $post->user_id) checks get forgotten in new actions. A policy is checked consistently and tested once.

Lazy loading in Blade

Accessing a relationship inside a loop fires a query per row. Laravel can be configured to throw on lazy loading in development to catch it.

Which Stack Rules Does the File Add?

  • Create classes with php artisan make:* (model, migration, controller, request, policy, test) so names and locations follow convention.
  • Validate input in Form Request classes, not inline in controllers.
  • Authorize with policies and $this->authorize() or can middleware for every action on a record.
  • Define $fillable on models; never use $guarded = [].
  • Eager-load relationships with with() in list queries; never query inside Blade loops.
  • Read configuration with config(); env() is only used inside config/*.php files, because it returns null once config is cached.
  • Use the query builder or Eloquent bindings; never interpolate input into DB::raw or whereRaw.

How Do You Add These Files to a Laravel Repository?

  1. Download the zip above. It is laid out exactly as the files go into the repository.
  2. Unzip it at the repository root. AGENTS.md, CLAUDE.md and GEMINI.md go next to your README; the Copilot file goes in .github/ and the Cursor rule in .cursor/rules/.
  3. Open AGENTS.md and check every command against your package scripts or Makefile.
  4. Delete wrappers for tools your team does not use, and any old .cursorrules or .windsurfrules file.
  5. Commit, then run the linter on AGENTS.md whenever you change it.

Want different commands or rules? Load this preset into the generator, change anything, and download your own set.

Which Agents Will Read These Files?

AGENTS.md is read directly by Codex, Cursor, Windsurf, Cline, Zed and Jules, and by GitHub Copilot's cloud agent, code review and CLI. Claude Code reads it through the generated CLAUDE.md, and Gemini CLI through GEMINI.md. See the compatibility table for details, last verified 2026-11-13.

Which Similar Stacks Are in the Library?

All presets are on the stacks page.

Frequently Asked Questions

Does this template use Pest or PHPUnit?

Pest, which runs on PHPUnit. php artisan test runs either, so the commands work if your project uses plain PHPUnit classes too.

Why include npm run build as the build command?

Laravel apps compile frontend assets with Vite. If your app has no frontend build, clear that command in the generator.

Is Larastan required?

No. The type-check command uses PHPStan, typically with the Larastan extension. Remove it in the generator if your project does not run static analysis.

Are these Laravel files free to use?

Yes. Copy them into any project, commercial or not, without attribution. They are a starting point: adjust the commands and rules to match your repository.

How Can You Verify That Nothing Leaves This Browser?

You do not have to take our word for it. Developer tools show every request a page makes, so you can watch this page work and confirm that nothing you type is sent. The check takes under a minute.

  1. Open your browser developer tools with F12, or Cmd+Option+I on a Mac, and select the Network tab.
  2. Reload the page and let it finish. You will see the page's own files, its web fonts, and one anonymous page-view request. Nothing has been typed yet, so none of them can contain your input.
  3. Click the clear icon in the Network tab so that the log is empty.
  4. Switch between the file tabs, copy a file and download the zip.
  5. Look at the Network tab again. It is still empty. Downloads are built in the page as Blob URLs, so even the zip never touches a server. For extra proof, turn on offline mode after the page loads: everything keeps working.

Only the feedback form can add a line to that log, and it sends only the vote and comment you type into it. 2prompt has no server code at all: no API, no model and no database of your files. The production site also sends a Content-Security-Policy header that tells your browser to refuse connections to anywhere except this site, the fonts and the anonymous analytics endpoint.

Was this helpful?