NUXT AGENTS.MD

Nuxt adds file-based routing, auto-imports and a Nitro server to Vue. These rules teach an agent the Nuxt way of fetching data and writing server endpoints, which differs from both plain Vue and Next.js.

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: nuxt-app. A Nuxt full-stack Vue app with server API routes.

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: Nuxt
- Database: PostgreSQL
- Hosting: Netlify
- 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 vitest run`
- Run one test file: `pnpm vitest run test/path/to/file.test.ts`
- Lint: `pnpm lint`
- Type-check: `pnpm nuxi typecheck`
- Format: `pnpm prettier --write .`

## Project layout

- `pages/`: File-based routes
- `components/`: Auto-imported components
- `composables/`: Auto-imported composables
- `server/api/`: Nitro API endpoints (defineEventHandler)
- `.nuxt/`: Generated build output and types (never 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.
- 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.
- 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

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

## Project-specific notes

- Fetch page data with `useFetch` or `useAsyncData` so it runs once on the server and hydrates; do not use raw `fetch` in `onMounted` for page data.
- Rely on auto-imports for Vue APIs, composables and components; do not add manual imports for them.
- Server endpoints live in `server/api/` and use `defineEventHandler`; validate the body with `readValidatedBody`.
- Secrets go in `runtimeConfig` (server-only keys) and are read with `useRuntimeConfig()` on the server; only `runtimeConfig.public` reaches the browser.
- Never edit anything in `.nuxt/` or `.output/`; they are regenerated on every run.
- Use `useState` for shared SSR-safe state, not a module-level `ref`, which leaks between requests on the server.

## 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: nuxt-app. A Nuxt full-stack Vue app with server API routes.

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: Nuxt
- Database: PostgreSQL
- Hosting: Netlify
- Tests: Vitest
- Package manager: pnpm

## Commands

- Install dependencies: `pnpm install`
- Run locally: `pnpm dev`
- Build: `pnpm build`
- Run all tests: `pnpm vitest run`
- Run one test file: `pnpm vitest run test/path/to/file.test.ts`
- Lint: `pnpm lint`
- Type-check: `pnpm nuxi typecheck`
- 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.
- 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 Nuxt preset

What Is in the Nuxt AGENTS.md?

The preset describes a a Nuxt full-stack Vue app with server API routes. Its AGENTS.md is 49 non-empty lines with 8 exact commands, 5 key directories, and 6 stack-specific rules on top of the shared working rules.

  • Commands: pnpm install, pnpm dev, pnpm build, pnpm vitest run, pnpm vitest run test/path/to/file.test.ts, pnpm lint, pnpm nuxi typecheck, pnpm prettier --write ..
  • Layout: pages/, components/, composables/, server/api/, .nuxt/.
  • 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 Nuxt?

Module-level state leaks across users

On the server, a ref declared at module scope is shared by every request. An agent that writes a quick global store can show one user another user data. useState is request-scoped, which is why the rule is explicit.

useFetch prevents double fetching

Fetching in onMounted runs only in the browser, so server rendering ships an empty page and the request repeats on the client. useFetch serializes the result into the payload.

Auto-imports look like missing imports

Agents see a bare ref() and add imports, which is harmless but noisy, or rename things and break the auto-import. Saying auto-imports are expected stops the churn.

runtimeConfig is the secret boundary

Keys under public are sent to the browser. Everything else stays on the server. Agents often put API keys in public by mistake to make a client call work.

Which Stack Rules Does the File Add?

  • Fetch page data with useFetch or useAsyncData so it runs once on the server and hydrates; do not use raw fetch in onMounted for page data.
  • Rely on auto-imports for Vue APIs, composables and components; do not add manual imports for them.
  • Server endpoints live in server/api/ and use defineEventHandler; validate the body with readValidatedBody.
  • Secrets go in runtimeConfig (server-only keys) and are read with useRuntimeConfig() on the server; only runtimeConfig.public reaches the browser.
  • Never edit anything in .nuxt/ or .output/; they are regenerated on every run.
  • Use useState for shared SSR-safe state, not a module-level ref, which leaks between requests on the server.

How Do You Add These Files to a Nuxt 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 for Nuxt 3 or Nuxt 4?

The rules use APIs common to current Nuxt releases. Nuxt 4 moves app code under an app/ directory by default; update the layout lines in the generator if your project uses that structure.

Why not call external APIs from the browser?

Proxying through server/api keeps keys server-side and lets you cache responses. Calling public, keyless APIs from the browser is fine; the rule is about secrets.

Does nuxi typecheck need extra packages?

It uses vue-tsc and typescript as dev dependencies. If they are missing, the command will tell you; install them once and the agent can run it.

Are these Nuxt 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?