Augment Code: .augment/rules/ location, format and template
Where Augment Code reads project instructions, whether it reads AGENTS.md, and what the format allows. From the official documentation, checked Oct 7, 2026. See also Augment Code: pricing, popularity and alternatives.
Project files
.augment/rules/*.mdand.augment-guidelinesat the workspace rootAGENTS.mdandCLAUDE.md, from the file's folder up to the root
Global (all projects)
~/.augment/rules/
AGENTS.md
✓ Yes (and CLAUDE.md).
Format and limits
- Front matter
type:always_apply,agent_requested(needsdescription) ormanual. - Limits: 24,576 characters of user guidelines; 49,512 for workspace guidelines plus rules.
Templates
AGENTS.md for a TypeScript project
AGENTS.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
Claude Code CLAUDE.mdOpenAI Codex AGENTS.mdCursor .cursor/rules/*.mdcGitHub Copilot .github/copilot-instructions.mdGemini CLI GEMINI.mdWindsurf (Devin Desktop) .windsurf/rules/*.mdCline .clinerules/Roo Code .roo/rules/Aider CONVENTIONS.mdZed .rulesJetBrains Junie .junie/AGENTS.mdKiro .kiro/steering/*.mdAmp AGENTS.mdContinue .continue/rules/goose AGENTS.md / .goosehintsOpenCode AGENTS.mdKilo Code AGENTS.mdFactory Droid AGENTS.mdQwen Code QWEN.mdWarp AGENTS.mdDevin AGENTS.mdJules AGENTS.mdReplit Agent replit.mdCrush CRUSH.md / AGENTS.md