readme points to wrong file for personal global guidance

Resolved 💬 1 comment Opened May 16, 2025 by christophkogler Closed Aug 7, 2025

What is the type of issue?

Documentation is incorrect

What is the issue?

The readme states:

You can give Codex extra instructions and guidance using AGENTS.md files. Codex looks for AGENTS.md files in the following places, and merges them top-down:

  1. ~/.codex/AGENTS.md - personal global guidance
  2. AGENTS.md at repo root - shared project notes
  3. AGENTS.md in the current working directory - sub-folder/feature specifics

This is incorrect. Personal global guidance is pulled from ~/.codex/instructions.md.

Documentation should be fixed first, but this makes it pretty clear that instruction file naming convention should be unified across all levels. They should probably either all be instructions.md or all be AGENTS.md.

Where did you find it?

https://github.com/openai/codex/blob/main/README.md#memory--project-docs

View original on GitHub ↗

This issue has 1 comment on GitHub. Read the full discussion on GitHub ↗