fix: migrate to AGENTS.md #764
Open
+24
−11
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
andmis
reviewed
May 1, 2025
| Disable with `--no-project-doc` or `CODEX_DISABLE_PROJECT_DOC=1`. | ||
| Disable loading of these files with `--no-project-doc` or the environment variable `CODEX_DISABLE_PROJECT_DOC=1`. | ||
|
|
||
| For backwards-compatibility with older Codex versions, `instructions.md` and `codex.md` are still supported but `AGENTS.md` is recommended. |
There was a problem hiding this comment.
Suggested change: remove this from the docs.
| @@ -226,13 +226,15 @@ Key flags: `--model/-m`, `--approval-mode/-a`, `--quiet/-q`, and `--notify`. | |||
|
|
|||
| ## Memory & Project Docs | |||
|
|
|||
| Codex merges Markdown instructions in this order: | |||
| Codex looks for Markdown agent files (preferred: `AGENTS.md`) in the following order and merges them top-down: | |||
There was a problem hiding this comment.
Suggested change: "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:"
| // --------------------------------------------------------------------------- | ||
|
|
||
| export const PROJECT_DOC_MAX_BYTES = 32 * 1024; // 32 kB | ||
|
|
||
| const PROJECT_DOC_FILENAMES = ["codex.md", ".codex.md", "CODEX.md"]; | ||
| // We support multiple filenames for project-level agent instructions. As of | ||
| // mid-2024 the recommended convention is to use `AGENTS.md`, however we keep |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Migrate from
codex.mdtoAGENTS.md