REACT ROUTER V7 (REMIX) AGENTS.MD

React Router v7 in framework mode is the continuation of Remix. These instructions keep an agent inside the loader and action model instead of reaching for client-side fetching and global state.

Zero retention: everything you type stays in this browser. Verify it yourself in DevTools.
The React Router v7 (Remix) filesCustomize in the generator
AGENTS.mdFor Codex, Cursor, Copilot, Jules, Windsurf and more
# AGENTS.md

Project: react-router-app. A React Router v7 framework-mode app (the successor to Remix) with server loaders and actions.

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: TypeScript
- Framework: React Router v7 / Remix
- Database: PostgreSQL
- Hosting: Fly.io
- Tests: Vitest
- Package manager: npm

## Commands

Run these from the repository root.

- Install dependencies: `npm install`
- Run locally: `npm run dev`
- Build: `npm run build`
- Run all tests: `npx vitest run`
- Run one test file: `npx vitest run path/to/file.test.ts`
- Lint: `npm run lint`
- Type-check: `npm run typecheck`
- Format: `npx prettier --write .`

## Project layout

- `app/routes/`: Route modules: loader, action, default component, meta
- `app/routes.ts`: The route config
- `app/components/`: Shared UI components
- `app/lib/`: Server-only helpers (files ending in .server.ts)
- `.react-router/types/`: Generated route types (do not edit)

## Code style

- Indent with 2 spaces. Never tabs.
- TypeScript runs in strict mode. Do not use `any`; use `unknown` and narrow it, or write the real type.
- Match the style and patterns of the surrounding code, even where you would personally choose differently.
- Use named exports. Do not add default exports.
- 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.
- 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

- Public pages must render their main content as HTML on the server, with a unique title, meta description and one h1.

## Project-specific notes

- Read data in the route `loader` and write data in the route `action`. Do not add client-side `useEffect` fetching for data a loader can provide.
- Use `<Form>` and `useFetcher` for mutations so they work without JavaScript; do not hand-roll `fetch` calls for form posts.
- Server-only code lives in files ending in `.server.ts` so it can never be bundled for the browser.
- Import route types from `./+types/<route>` and type loader and action arguments with them; run `npm run typecheck` after adding a route, which regenerates the types.
- Register every new route in `app/routes.ts`.
- Throw `data()` responses with the right status (404, 403) from loaders instead of returning null.
- Do not import from `@remix-run/*`; in React Router v7 everything comes from `react-router` and `@react-router/*`.

## 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: react-router-app. A React Router v7 framework-mode app (the successor to Remix) with server loaders and actions.

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: TypeScript
- Framework: React Router v7 / Remix
- Database: PostgreSQL
- Hosting: Fly.io
- Tests: Vitest
- Package manager: npm

## Commands

- Install dependencies: `npm install`
- Run locally: `npm run dev`
- Build: `npm run build`
- Run all tests: `npx vitest run`
- Run one test file: `npx vitest run path/to/file.test.ts`
- Lint: `npm run lint`
- Type-check: `npm run typecheck`
- Format: `npx prettier --write .`

## 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.
- 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 React Router v7 (Remix) preset

What Is in the React Router v7 (Remix) AGENTS.md?

The preset describes a a React Router v7 framework-mode app (the successor to Remix) with server loaders and actions. Its AGENTS.md is 51 non-empty lines with 8 exact commands, 5 key directories, and 7 stack-specific rules on top of the shared working rules.

  • Commands: npm install, npm run dev, npm run build, npx vitest run, npx vitest run path/to/file.test.ts, npm run lint, npm run typecheck, npx prettier --write ..
  • Layout: app/routes/, app/routes.ts, app/components/, app/lib/, .react-router/types/.
  • 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 React Router v7 (Remix)?

Loaders beat effects

Agents default to the single-page-app habit of fetching inside useEffect. In framework mode that throws away server rendering, creates loading spinners the framework would have avoided, and duplicates data logic. Telling the agent where reads and writes belong is the single most effective rule for this stack.

The Remix rename confuses models

Much of the training data is Remix v2 with @remix-run/* imports. React Router v7 moved those APIs into react-router. Without the rule, agents mix both packages and produce code that will not build.

The .server convention is a safety net

A helper that reads an API key is harmless in a loader and a leak in a component. The .server.ts suffix makes the build fail if a browser bundle imports it, which turns a silent leak into a loud error.

Typed routes need regeneration

Route types are generated. When an agent adds a route and sees type errors, the fix is to regenerate, not to cast to any.

Which Stack Rules Does the File Add?

  • Read data in the route loader and write data in the route action. Do not add client-side useEffect fetching for data a loader can provide.
  • Use <Form> and useFetcher for mutations so they work without JavaScript; do not hand-roll fetch calls for form posts.
  • Server-only code lives in files ending in .server.ts so it can never be bundled for the browser.
  • Import route types from ./+types/<route> and type loader and action arguments with them; run npm run typecheck after adding a route, which regenerates the types.
  • Register every new route in app/routes.ts.
  • Throw data() responses with the right status (404, 403) from loaders instead of returning null.
  • Do not import from @remix-run/*; in React Router v7 everything comes from react-router and @react-router/*.

How Do You Add These Files to a React Router v7 (Remix) 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

Is this file for Remix or React Router?

Both, in the sense that React Router v7 framework mode is where Remix development continued. If you are still on Remix v2, keep the loader and action rules and change the import rule to @remix-run packages.

Why ban client-side fetching?

It is not banned everywhere; the rule only applies to data a loader can provide. Loaders render on the server, revalidate after actions automatically, and avoid loading states, so they are the default an agent should reach for first.

Does it work with a SPA-mode React Router app?

Partly. In SPA mode there is no server loader, so use the clientLoader rules instead. Edit the notes in the generator before downloading.

Are these React Router v7 (Remix) 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?