What to put in an AGENTS.md for Vue
Agents mix Vue 2 with Vue 3 and Nuxt 3 with Nuxt 4, so state the versions. In Nuxt 4, app code lives in app/ and most imports are automatic, so an agent adding them learned another setup.
Which commands should it list?
nuxt devNuxt dev server; checks no typesnuxt typecheckruns vue-tsc; dev and build skip typesnuxt prepareregenerate the.nuxttypes after config changesvue-tsc --noEmitplain Vue on Vite: type check the SFCs Vite only transpiles
Write them as your repo runs them, with its package manager and flags, plus how to run one test.
What layout should it explain?
- Plain Vue on Vite or Nuxt; for Nuxt, whether it uses the v4
app/srcDir or the older root layout. - Which directories are auto-imported:
app/components,app/composables,app/utils, andserver/utilson the server. - Where server code (
server/) sits relative to app code, and any Nuxt layers.
What do agents get wrong?
- Nuxt auto-imports components, composables, utils and Vue APIs like
ref; don't add imports, and use#importswhen one must be explicit. - The browser sees only
runtimeConfig.public; secrets go in top-levelruntimeConfig. - Override config with
NUXT_variables:NUXT_PUBLIC_API_BASEsetspublic.apiBase.
From the official docs: vuejs.org/quick-start (new tab) · vuejs.org/overview (new tab) · nuxt.com/upgrade (new tab) · nuxt.com/auto-imports (new tab) · nuxt.com/runtime-config (new tab) · nuxt.com/typescript (new tab). The rest of the file is the same for any project: what goes in an AGENTS.md.
Vue repos with an AGENTS.md or CLAUDE.md (3)
Built on Vue; 3 pass the AGENTS.md check in full.
| Repo | File | Length | Language |
|---|---|---|---|
| n8n-io/ | AGENTS.md | 25,421 chars | |
| nuxt/ | AGENTS.md | 947 chars | |
| directus/ | AGENTS.md | 8,016 chars |
More examples: Next.js · React · FastAPI · Django · Rails · Laravel · Android · Flutter · all examples