SvelteKit · AGENTS.md

The SvelteKit AGENTS.md, done right.

Copy a production-ready example below, or generate one tuned to your exact SvelteKit setup in about thirty seconds — free, in your browser.

 AGENTS.md
# your-sveltekit-app

> SvelteKit project.

Instructions for AI coding agents working in this repository.

## Setup

- Install dependencies: `pnpm install`
- Start dev server: `pnpm dev`
- Run tests: `pnpm test`

## Code style

- TypeScript strict mode.
- Load data in `+page.server.ts`, not in components.
- Keep stores small and purpose-specific.

## Guardrails

Things agents get wrong here. Follow these strictly:

- Don’t edit `.svelte-kit/` — it is generated.
- Don’t access browser-only APIs in server load functions.

Why SvelteKit projects need this

Dropped into a SvelteKit repo with no context, an AI agent guesses: it reaches for the wrong package manager, ignores your structure, and edits files it shouldn’t. AGENTS.md is the briefing it reads first — so the very next prompt behaves like a teammate who already knows your conventions.

What to put in it

The example above covers the three sections that matter most for SvelteKit: the real setup commands (pnpm install, pnpm dev, pnpm test), your code-style conventions, and the guardrails agents reliably get wrong. The generator fills these in from your actual manifest so the commands match your project, not a generic template.

Frequently asked

What is an AGENTS.md file in a SvelteKit project?

It is a markdown file at your repo root that tells AI coding agents how your SvelteKit project works — setup commands, code style and guardrails — so they follow your conventions instead of guessing.

Which tools read this file?

AGENTS.md is a shared convention read by Cursor, Claude Code, OpenAI Codex, GitHub Copilot, Gemini, Windsurf, Zed and others. For tools with their own filename you can export that format or symlink it to AGENTS.md.

What should a SvelteKit AGENTS.md include?

At minimum: install/dev/test commands (pnpm install, pnpm dev, pnpm test), your code-style conventions, and the guardrails agents get wrong — like Don’t edit .svelte-kit/ — it is generated.

Other stacks

Generate your SvelteKit AGENTS.md

Detect your stack, tune the guardrails, export to every agent format. Free.

Open the generator