Crush: `CRUSH.md / AGENTS.md` location, format and template

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

Project files

Reads AGENTS.md, CRUSH.md, CLAUDE.md, GEMINI.md, .cursorrules, .cursor/rules/ and .github/copilot-instructions.md, plus .local.md variants

Global (all projects)

~/.config/crush/CRUSH.md and ~/.config/AGENTS.md

AGENTS.md

✓ Yes; /init creates AGENTS.md by default.

Format and limits

From Crush's source code; the README doesn't list the files.

Sources: github.com/charmbracelet/crush

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.

Crush: CRUSH.md / AGENTS.md location, format and template