Skip to content

Add an option to fall back to an alternative filename for the project-level instrucion file (AGENTS.md) if it's not present #4376

@byrongrogan

Description

@byrongrogan

What feature would you like to see?

I'm looking at migrating some larger monorepos to work with Codex CLI, but Codex is currently hampered vs. other tooling we've already adopted by the lack of project-level docs (AGENTS.md vs CLAUDE.md).

Currently, in order to make this immediately work well with Codex CLI, we'd need to add AGENTS.md symlinks at each level of the project hierarchy that already has prior instruction files, across all of our repos. This is a bit of a mess when we have hundreds of projects and many repos where we'd need to do this.

So the request is: give us a config option that provides a fallback filename that you check when AGENTS.md doesn't exist at some level of the directory hierarchy. Concretely, this would just need to append to this single-item list here, based on a config option:

const CANDIDATE_FILENAMES: &[&str] = &["AGENTS.md"];

So with this, AGENTS.md would always be preferred if present (allowing people to migrate to better Codex-oriented prompting over time), but things would more or less "just work" immediately for repos/projects that already have prompts for other tools.

Are you interested in implementing this feature?

Happy to implement this if preferred.

Additional information

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions