VUE 3 + VITE AGENTS.MD

A Vue 3 single-page app built with Vite. The instructions pin the agent to the Composition API and script setup, since much of the Vue code on the internet is still Options API and Vue 2.

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

Project: vue-app. A Vue 3 single-page app built with Vite, TypeScript, Pinia and Vue Router.

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: Vue 3 + Vite
- 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 test:unit`
- Run one test file: `pnpm vitest run src/path/to/file.spec.ts`
- Lint: `pnpm lint`
- Type-check: `pnpm vue-tsc --noEmit`
- Format: `pnpm prettier --write src/`

## Project layout

- `src/components/`: Single-file components
- `src/views/`: Route-level components
- `src/stores/`: Pinia stores
- `src/composables/`: Reusable composition functions (useX)
- `src/router/`: Vue Router configuration

## 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.
- Every new UI control works with a keyboard, has a visible focus state and an accessible name.

## 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.
- Change only what the task needs. Do not refactor, rename or reformat unrelated code.

## Project-specific notes

- Use `<script setup lang="ts">` and the Composition API in every component. Do not write Options API or Vue 2 syntax.
- Type props with `defineProps<{...}>()` and events with `defineEmits<{...}>()`.
- Shared state goes in Pinia setup stores in `src/stores/`; do not use a global event bus or mutate props.
- Do not destructure a reactive object or store directly; use `storeToRefs` or `toRefs` so reactivity survives.
- Extract reusable logic into composables named `useX` in `src/composables/`.
- Use `vue-tsc` for type-checking; plain `tsc` does not understand `.vue` files.

## 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: vue-app. A Vue 3 single-page app built with Vite, TypeScript, Pinia and Vue Router.

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: Vue 3 + Vite
- Hosting: Netlify
- Tests: Vitest
- Package manager: pnpm

## Commands

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

## 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.
- 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 Vue 3 + Vite preset

What Is in the Vue 3 + Vite AGENTS.md?

The preset describes a a Vue 3 single-page app built with Vite, TypeScript, Pinia and Vue Router. Its AGENTS.md is 46 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 test:unit, pnpm vitest run src/path/to/file.spec.ts, pnpm lint, pnpm vue-tsc --noEmit, pnpm prettier --write src/.
  • Layout: src/components/, src/views/, src/stores/, src/composables/, src/router/.
  • 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 Vue 3 + Vite?

Two Vue dialects in the training data

Vue 2 and the Options API dominate older tutorials. Without guidance, agents mix data() and methods with ref() in the same file. Declaring script setup as the only style removes the ambiguity in one line.

Destructuring breaks reactivity

Pulling fields out of a reactive object or a Pinia store copies their current values and silently disconnects the UI from future changes. It is one of the most common Vue bugs and agents produce it constantly.

vue-tsc, not tsc

Plain TypeScript cannot read .vue files, so tsc reports nothing about the components that matter most. The rule names the right tool.

Props are one-way

Mutating a prop works by accident in some cases and warns in others. Stores and emitted events are the supported channels.

Which Stack Rules Does the File Add?

  • Use <script setup lang="ts"> and the Composition API in every component. Do not write Options API or Vue 2 syntax.
  • Type props with defineProps<{...}>() and events with defineEmits<{...}>().
  • Shared state goes in Pinia setup stores in src/stores/; do not use a global event bus or mutate props.
  • Do not destructure a reactive object or store directly; use storeToRefs or toRefs so reactivity survives.
  • Extract reusable logic into composables named useX in src/composables/.
  • Use vue-tsc for type-checking; plain tsc does not understand .vue files.

How Do You Add These Files to a Vue 3 + Vite 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

Does this template work with Nuxt?

Nuxt has its own conventions for routing, data fetching and server code, so use the Nuxt template instead. The component rules overlap, but the layout and commands differ.

Why Pinia and not Vuex?

Pinia is the official state library for Vue 3 and Vuex is in maintenance mode. If your project still uses Vuex, replace the store rule in the generator.

Should test files be .spec.ts or .test.ts?

Either works with Vitest. The template follows the create-vue default of .spec.ts; match whatever your repository already uses.

Are these Vue 3 + Vite 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?