AGENTS.md
AGENTS.md for Remix
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 Remix project. This repository is a Remix app. Data loads in loaders, mutations happen in actions, and forms work without a custom client fetch.
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 Remix with loaders and actions. It does not assume Vite versus the classic compiler, or a particular CSS system. Follow the remix.config or vite.config the repo has.
Example file
Balanced strictness, readable style, pragmatic tests. Download name: AGENTS.md
# AGENTS.md
Instructions for coding agents working in this Remix repository. Cursor, Claude Code, Codex, Copilot, and other agents should follow this file before they guess.
## Stack
This repository is a Remix app. Data loads in loaders, mutations happen in actions, and forms work without a custom client fetch.
## Layout
- Route modules live in the routes directory the project already uses.
- Shared UI lives next to routes or in a components folder the repo has.
- Server-only modules stay out of client imports.
## Commands
- Dev server: `npm run dev`
- Typecheck: `npm run typecheck`
- Tests: `npm test`
Use the script the repo already defines when it differs from the command above.
## Conventions
- Load data in a `loader`. Mutate in an `action`.
- Use Form or the project's fetcher. Do not hand-roll fetch for a mutation the action can do.
- Return `json` or the typed response helper the version of Remix in the repo uses.
- Validate form data on the server. The client check is a convenience.
- Keep nested route boundaries. Do not lift every loader to the root.
- Match the existing session and cookie helpers.
## Testing
Add or update tests when behavior changes.
Call the loader or action with a Request in a unit test. Cover the invalid form case.
## 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.
- Return a 4xx Response or the typed error the app uses for bad input. Unexpected errors hit the error boundary.
## 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 fetch the route's own loader data from useEffect.
- Do not import server code into a file that ships to the browser.
- Do not throw a bare string. Use the project's error response.
- Do not add a global client cache for data the loader already owns.
## Done when
- The requested behavior works.
- The route loader and action typecheck, and the form still works without JavaScript if it did before.
- 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 Remix 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 Remix agent often gets wrong, such as a loader that returns data the route renders without useEffect. 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 Remix repo?
Save it as `AGENTS.md` at the root of the Remix 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 Remix example assume?
The example assumes Remix with loaders and actions. It does not assume Vite versus the classic compiler, or a particular CSS system. Follow the remix.config or vite.config the repo has.
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 Remix
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 Laravel
- 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 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