Gemini CLI: GEMINI.md location, format and template
Where Gemini CLI reads project instructions, whether it reads AGENTS.md, and what the format allows. From the official documentation, checked Oct 7, 2026. See also Gemini CLI: pricing, popularity and alternatives.
Project files
GEMINI.mdin the project and its parent foldersGEMINI.mdin a subfolder loads when a tool touches a file there
Global (all projects)
~/.gemini/GEMINI.md
AGENTS.md
– Only if you add it: set context.fileName in settings.json, e.g. ["AGENTS.md", "GEMINI.md"].
Format and limits
- Import files with
@file.md; imports nest up to 5 levels. /memory showprints the combined context;/memory reloadre-reads the files..geminiignorekeeps files out of context.
Sources: geminicli.com/docs/cli/gemini-md/
Templates
Make Gemini CLI read AGENTS.md
.gemini/settings.json{
"context": {
"fileName": ["AGENTS.md", "GEMINI.md"]
}
}
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.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.mdAugment Code .augment/rules/Factory Droid AGENTS.mdQwen Code QWEN.mdWarp AGENTS.mdDevin AGENTS.mdJules AGENTS.mdReplit Agent replit.mdCrush CRUSH.md / AGENTS.md