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

OpenCode: AGENTS.md location, format and template

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

Project files

  • AGENTS.md found by walking up from your folder; CLAUDE.md if there is none
  • Extra files or globs in the instructions list of opencode.json

Global (all projects)

  • ~/.config/opencode/AGENTS.md (falls back to ~/.claude/CLAUDE.md)

AGENTS.md

✓ Native format.

Format and limits

  • /init creates or improves AGENTS.md.
  • OPENCODE_DISABLE_CLAUDE_CODE=1 turns off the CLAUDE.md fallbacks.

Sources: opencode.ai/docs/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.
Extra instruction files in OpenCodeopencode.json
{
  "instructions": ["CONTRIBUTING.md", "docs/guidelines.md", ".cursor/rules/*.md"]
}

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

Other agents

All agents and the one-file setup →