agentleFS
nuxtnuxt/devtools/AGENTS.md

devtools

AGENTS.md3.3k starsChanged 45 days agoMITView on GitHub

Guidance for contributors and AI agents working in this repo. - packages/devtools — the main Nuxt module. Its client/ directory is a separate Nuxt app that renders the DevTools UI; src/server-rpc/** is the server surface that runs on the Node dev server and is called from that browser client. - packages/devtools-kit — the module-author API, built with unbuild. - packages/devtools-ui-kit — a Nuxt UI component module used by the client. (pnpm test:e2e runs both the dev and built e2e suites;…

Trending

More talk lately.about the whole repository

Dec 2025: 2 mentionsJan 2026: 5 mentionsFeb 2026: 1 mentionMar 2026: 3 mentionsApr 2026: 2 mentionsMay 2026: 0 mentionsJun 2026: 0 mentionsJul 2026: 1 mentionAug 2026: 2 mentionsSep 2026: 0 mentionsOct 2026: 2 mentionsNov 2026: 4 mentions
Dec 2025Jun 2026Nov 2026
Mentions a month of the nuxt/devtools repository that our weekly crawl found. There is no adoption data for this file yet.

Who's talking about nuxt/devtools

The biggest 5 of 40 mentions linking to the repository that our crawl found. Each line is their own headline.

See all 40

Talked about on GitHub, Hacker News, Bluesky and Stack Overflow (40 times).

On GitHub · 37

32 more on GitHub

On Hacker News · 1

On Bluesky · 1

On Stack Overflow · 1

The file

Files
AGENTS.md

AGENTS.md

Guidance for contributors and AI agents working in this repo.

High-Level Instructions

  • Right now we are working on Nuxt DevTools v4, which is built on top of Vite DevTools Kit and Devframe
  • Nuxt DevTools v4 will be default in Nuxt 5, while we it should still work with Nuxt 4.
  • There are quite some Nuxt Module built on top of Nuxt DevTools v3's legacy API, we should make sure those modules are still working with Nuxt DevTools v4 (backward compatibility) and provide a migration guide for module authors to migrate to the new vite-devtools-based API.
  • Nuxt 5 introduce Nitro v3 (nitro@3) while Nuxt 4 is still using Nitro v2 (nitropack@2). We should make sure that Nuxt DevTools v4 works with both Nitro v2 and v3, without introduce hard dependency on either of them.

Packages

  • packages/devtools — the main Nuxt module. Its client/ directory is a separate Nuxt app that renders the DevTools UI; src/server-rpc/** is the server surface that runs on the Node dev server and is called from that browser client.
  • packages/devtools-kit — the module-author API, built with unbuild.
  • packages/devtools-ui-kit — a Nuxt UI component module used by the client.

Everyday commands

CommandPurpose
pnpm lintESLint over the whole repo
pnpm typecheckvue-tsc --noEmit (requires prepare/build first)
pnpm knipFind unused files/deps/exports (requires prepare/build first)
pnpm testRuns pnpm lint && pnpm test:unit
pnpm test:unitUnit tests via vitest run
pnpm test:e2e:devPlaywright e2e against the dev server
pnpm test:e2e:builtPlaywright e2e against a built app

(pnpm test:e2e runs both the dev and built e2e suites; config lives at tests/e2e/playwright.config.ts.)

Dependency model

Dependency versions are pinned centrally via pnpm catalogs in pnpm-workspace.yaml (e.g. catalog:cli, catalog:prod, catalog:frontend, catalog:buildtools). When adding a dependency, reference it as catalog:<name> in the package's package.json rather than pinning a raw version — add the version to the appropriate catalog in pnpm-workspace.yaml if it isn't there yet.

Package manager

This repo uses pnpm 11 (see packageManager in the root package.json). Use pnpm, not npm or yarn.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.