SVELTEKIT AGENTS.MD

SvelteKit on Svelte 5. The biggest risk with agents here is the syntax change to runes: most training data is Svelte 4, so these files state the current idioms explicitly.

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

Project: sveltekit-app. A SvelteKit app on Svelte 5 with server load functions and form actions.

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: SvelteKit
- Database: SQLite
- Hosting: Vercel
- 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`
- Run one test file: `pnpm vitest run src/path/to/file.test.ts`
- Lint: `pnpm lint`
- Type-check: `pnpm check`
- Format: `pnpm format`

## Project layout

- `src/routes/`: Routes: +page.svelte, +page.server.ts, +layout.svelte, +server.ts
- `src/lib/`: Shared code, imported as $lib
- `src/lib/server/`: Server-only modules, imported as $lib/server
- `static/`: Static assets
- `tests/`: Playwright end-to-end tests

## Code style

- Indent with tabs. Never spaces for indentation.
- 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.
- 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 Svelte 5 runes: `$state`, `$derived`, `$effect`, `$props`. Do not write Svelte 4 syntax (`export let`, `$:` reactive statements, `on:click`).
- Use event attributes like `onclick={handler}`, not `on:click`.
- Load data in `+page.server.ts` `load` functions and mutate with form actions; enhance forms with `use:enhance`.
- Code that touches secrets or the database goes in `src/lib/server/`; SvelteKit refuses to bundle it for the browser.
- Read private env vars from `$env/static/private` or `$env/dynamic/private`, never from `$env/static/public`.
- Prefer `$derived` over `$effect` for computed values; `$effect` is for side effects only.
- Run `pnpm check` (svelte-check) after changing components or types.

## 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: sveltekit-app. A SvelteKit app on Svelte 5 with server load functions and form actions.

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: SvelteKit
- Database: SQLite
- Hosting: Vercel
- Tests: Vitest
- Package manager: pnpm

## Commands

- Install dependencies: `pnpm install`
- Run locally: `pnpm dev`
- Build: `pnpm build`
- Run all tests: `pnpm test`
- Run one test file: `pnpm vitest run src/path/to/file.test.ts`
- Lint: `pnpm lint`
- Type-check: `pnpm check`
- Format: `pnpm format`

## 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 SvelteKit preset

What Is in the SvelteKit AGENTS.md?

The preset describes a a SvelteKit app on Svelte 5 with server load functions and form actions. Its AGENTS.md is 47 non-empty lines with 8 exact commands, 5 key directories, and 7 stack-specific rules on top of the shared working rules.

  • Commands: pnpm install, pnpm dev, pnpm build, pnpm test, pnpm vitest run src/path/to/file.test.ts, pnpm lint, pnpm check, pnpm format.
  • Layout: src/routes/, src/lib/, src/lib/server/, static/, tests/.
  • 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 SvelteKit?

Svelte 5 changed the syntax

Runes replaced export let props and $: reactive statements. Agents trained mostly on Svelte 4 produce code that still compiles in legacy mode but mixes paradigms and confuses everyone. Listing the banned forms is more effective than only naming the new ones.

$effect is not a computed value

Writing state inside $effect to mirror other state recreates the React effect anti-pattern. $derived is simpler and cannot loop.

$lib/server is enforced

SvelteKit fails the build if browser code imports a server-only module. Telling the agent to put secret-touching code there turns a leak into a compile error.

Tabs are the default

The official Svelte templates and Prettier plugin use tabs. Agents switch to spaces by habit, producing noisy diffs; the indent rule prevents it.

Which Stack Rules Does the File Add?

  • Use Svelte 5 runes: $state, $derived, $effect, $props. Do not write Svelte 4 syntax (export let, $: reactive statements, on:click).
  • Use event attributes like onclick={handler}, not on:click.
  • Load data in +page.server.ts load functions and mutate with form actions; enhance forms with use:enhance.
  • Code that touches secrets or the database goes in src/lib/server/; SvelteKit refuses to bundle it for the browser.
  • Read private env vars from $env/static/private or $env/dynamic/private, never from $env/static/public.
  • Prefer $derived over $effect for computed values; $effect is for side effects only.
  • Run pnpm check (svelte-check) after changing components or types.

How Do You Add These Files to a SvelteKit 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 Svelte 4?

No. The rules assume runes. For a Svelte 4 project, remove the runes rules in the generator and describe your current syntax instead, or plan the migration first.

Why is the type-check command pnpm check?

SvelteKit projects run svelte-check through a check script, which understands .svelte files and the generated route types. Plain tsc does not.

Which adapter should I use?

That depends on your host. The template assumes Vercel; switch the hosting choice in the generator and mention your adapter in the notes.

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