Skip to content
Agents tracked: 258 Downloads (7d): 219M up 6.1% GitHub stars: 5.5M VS Code installs: 148M Releases (7d): 327 Agent status: 1 with issues Updated Oct 7, 2026

Zed: .rules location, format and template

Where Zed reads project instructions, whether it reads AGENTS.md, and what the format allows. From the official documentation, checked Oct 7, 2026. See also Zed: pricing, popularity and alternatives.

Project files

  • One rules file at the top of the project; Zed uses the first it finds of: .rules, .cursorrules, .windsurfrules, .clinerules, .github/copilot-instructions.md, AGENT.md, AGENTS.md, CLAUDE.md, GEMINI.md

Global (all projects)

  • The Rules Library (in the app); rules marked Default go into every new thread

AGENTS.md

✓ Yes, but only if none of the higher-priority files exists.

Format and limits

  • Only one project file is used, so keep a single source of truth.

Sources: zed.dev/docs/ai/rules

Templates

AGENTS.md for a TypeScript projectAGENTS.md
# AGENTS.md

## Project
One paragraph: what this repository does and who uses it.

## Commands
- Install: `pnpm install`
- Dev server: `pnpm dev`
- Tests: `pnpm test` (run before you finish)
- Lint and types: `pnpm lint && pnpm typecheck`

## Layout
- `src/app/`: routes and pages
- `src/lib/`: shared logic, no UI code
- `tests/`: mirrors `src/`

## Conventions
- TypeScript strict mode; avoid `any`.
- Follow the patterns already in `src/` before adding new ones.
- Small, focused functions; name things for what they do.

## Boundaries
- Never read or edit `.env*` files or commit secrets.
- Ask before adding a dependency or changing a public API.

## Done means
Tests pass, lint is clean, and the change is explained in the PR description.

Written by AgentGid as a starting point; swap in your own commands and folders.

Other agents

All agents and the one-file setup →