NEXT.JS + SUPABASE AGENTS.MD

A Next.js App Router project backed by Supabase for Postgres, Auth and Storage. These files teach a coding agent where the server and client boundary sits, how to talk to Supabase safely, and which commands prove a change works.

Zero retention: everything you type stays in this browser. Verify it yourself in DevTools.
The Next.js + Supabase filesCustomize in the generator
AGENTS.mdFor Codex, Cursor, Copilot, Jules, Windsurf and more
# AGENTS.md

Project: nextjs-supabase-app. A Next.js App Router app backed by Supabase (Postgres, Auth, Storage), deployed on Vercel.

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

- Languages: TypeScript, SQL
- Framework: Next.js (App Router)
- Database: Supabase (Postgres)
- Hosting: Vercel
- Tests: Vitest
- Package manager: pnpm

## Commands

Run these from the repository root.

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

## Project layout

- `app/`: App Router routes, layouts, loading and error boundaries
- `components/`: Shared React components
- `lib/supabase/`: Supabase clients: server.ts for Server Components and actions, client.ts for the browser
- `supabase/migrations/`: SQL migrations, applied with the Supabase CLI
- `types/database.ts`: Generated database types (do not edit by hand)

## 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.
- Do not hand-edit generated files or lockfiles; change the source and regenerate.
- 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

- Components are Server Components by default. Add "use client" only for state, effects, event handlers or browser APIs, and keep client components small and at the leaves.
- Never import the service-role key, or any module that reads it, from client code. Only `NEXT_PUBLIC_` variables may reach the browser.
- Row Level Security is enabled on every table. A new table ships with its RLS policies in the same migration.
- Use the server client from `lib/supabase/server.ts` in Server Components, Route Handlers and Server Actions; use the browser client only in client components.
- Schema changes go in a new file under `supabase/migrations/` created with `supabase migration new`; then regenerate types with `supabase gen types typescript`.
- Mutations go through Server Actions or Route Handlers that re-check the user session; never trust a user id sent from the client.
- Call `revalidatePath` or `revalidateTag` after a mutation that changes cached data.

## 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: nextjs-supabase-app. A Next.js App Router app backed by Supabase (Postgres, Auth, Storage), deployed on Vercel.

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

- Languages: TypeScript, SQL
- Framework: Next.js (App Router)
- Database: Supabase (Postgres)
- Hosting: Vercel
- Tests: Vitest
- Package manager: pnpm

## Commands

- Install dependencies: `pnpm install`
- Run locally: `pnpm dev`
- Build: `pnpm build`
- Run all tests: `pnpm test`
- Run one test file: `pnpm vitest run path/to/file.test.ts`
- Lint: `pnpm lint`
- Type-check: `pnpm tsc --noEmit`
- Format: `pnpm 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.
- Do not hand-edit generated files or lockfiles; change the source and regenerate.
- 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 Next.js + Supabase preset

What Is in the Next.js + Supabase AGENTS.md?

The preset describes a a Next.js App Router app backed by Supabase (Postgres, Auth, Storage), deployed on Vercel. Its AGENTS.md is 52 non-empty lines with 8 exact commands, 5 key directories, and 7 stack-specific rules on top of the shared working rules.

  • Commands: pnpm install, pnpm dev, pnpm build, pnpm test, pnpm vitest run path/to/file.test.ts, pnpm lint, pnpm tsc --noEmit, pnpm prettier --write ..
  • Layout: app/, components/, lib/supabase/, supabase/migrations/, types/database.ts.
  • 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 Next.js + Supabase?

Why the client boundary matters

Agents trained on older React habitually add "use client" to the top of every file that imports a hook, which silently turns whole route trees into client bundles and leaks server-only imports. Stating the default explicitly, and asking for client components at the leaves, keeps data fetching on the server where the Supabase session and secrets already live.

The service-role key is the one secret that ends a project

The service-role key bypasses Row Level Security entirely. If an agent imports it into a file that a client component also imports, it is bundled and shipped to every visitor. The rule names both the key and the NEXT_PUBLIC_ prefix so the agent can check the boundary mechanically.

RLS in the same migration

A table created without policies is either unreadable or, if RLS is off, readable by anyone with the anon key. Agents often create the table in one step and forget the policies. Requiring both in one migration makes the omission visible in review.

Generated types are an output

The database types file is regenerated from the schema. When an agent edits it by hand to make a type error go away, the next regeneration erases the fix and the real schema mismatch stays hidden.

Which Stack Rules Does the File Add?

  • Components are Server Components by default. Add "use client" only for state, effects, event handlers or browser APIs, and keep client components small and at the leaves.
  • Never import the service-role key, or any module that reads it, from client code. Only NEXT_PUBLIC_ variables may reach the browser.
  • Row Level Security is enabled on every table. A new table ships with its RLS policies in the same migration.
  • Use the server client from lib/supabase/server.ts in Server Components, Route Handlers and Server Actions; use the browser client only in client components.
  • Schema changes go in a new file under supabase/migrations/ created with supabase migration new; then regenerate types with supabase gen types typescript.
  • Mutations go through Server Actions or Route Handlers that re-check the user session; never trust a user id sent from the client.
  • Call revalidatePath or revalidateTag after a mutation that changes cached data.

How Do You Add These Files to a Next.js + Supabase 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

Should CLAUDE.md for a Next.js project repeat the AGENTS.md content?

No. Keep the content in AGENTS.md and import it from CLAUDE.md with the @AGENTS.md line, so Claude Code and every other agent read the same rules and you only edit one file.

Do these rules work with the Next.js Pages Router?

Mostly not. The rules assume the App Router, Server Components and Server Actions. For a Pages Router project, change the layout and the client boundary rule in the generator before you download.

Can an agent run Supabase migrations from these instructions?

The working rules ask the agent to ask before creating or running migrations. That is deliberate: a wrong migration against a shared database is hard to undo. Remove the rule if you work only against a local Supabase instance.

Are these Next.js + Supabase 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?