feat: add configuration section with config instructions for claude code

[marcusschiesser]

• adds a new configuration section
• move aider and gemini cli configuration there
• add how to configure agents.md for claude code

[vercel[bot]]

@marcusschiesser is attempting to deploy a commit to the openai Team on Vercel.

A member of the Team first needs to authorize it.

[romainhuet]

Thank you for this pull request! Just curious, for simplicity, could it be done as a symlink like we suggested for AGENT.md pointing to AGENTS.md?

[marcusschiesser]

@romainhuet I wouldn't use symlinks as they don't work well with git repos. I resolved the conflict - please have a look again

[marcusschiesser]

@romainhuet @jomarmontuya updated PR description

[sgryphon]

I don't mind separating out into a separate page, but maybe make a distinction between straight configuration and work arounds.

E.g. Gemini and Aider are straight configuration. They explicitly include a way to set the file name to load, so all you need to do is configure the right way. The configuration is specifically for loading context files.

And then there are work arounds. The most obvious being that many tools will support a symlink from their proprietary named file to AGENTS.md. Maybe provide both Windows and Linux/MAC versions as they work differently.

Work arounds also includes your proposal to hook into before/after events and copy the files. A similar option for some is to use a batch file / shell script to copy and then run.

Someone else put up a suggestion that you could just copy and paste the contents into the relevant file.

Sure, all of these work, but they aren't configuration -- they are work arounds using some other/generic capability (file copy, event hooks, etc) to achieve consistency.

[sgryphon]

And then there are work arounds. The most obvious being that many tools will support a symlink from their proprietary named file to AGENTS.md. Maybe provide both Windows and Linux/MAC versions as they work differently.

Some suggested wording for the symlink workaround (my original example was for Claude, but you have Claude using event hooks).

---

Workaround: Using symlinks

You may also be able to configure other tools by linking the file they use to AGENTS.md, for example to configure Cursor:

On Linux:

ln -s AGENTS.md .cursorrules

On Windows:

mklink .cursorrules AGENTS.md

---

I think providing different work around suggestions to people is useful (but not the same as configuration).

[marcusschiesser]

@sgryphon not sure we need to distinguish this - for the user it either works out of the box or he has to do something to make it work. This is covered by the ConfigurationSection in this PR. @romainhuet what are your thoughts?

[sgryphon]

@sgryphon not sure we need to distinguish this - for the user it either works out of the box or he has to do something to make it work. This is covered by the ConfigurationSection in this PR. @romainhuet what are your thoughts?

Maybe, although I hope there is some sort of threshold for being listed as supporting the standard.

I think Gemini (and Aider) qualify, because picking the name of the file is literally an option (that option has no functionality other than picking the instructions file name). It still needs to be configured, but that configuration option has no other purpose.

Otherwise, well anyone can to a "cp AGENTS.md any-file-name.txt" ... or even (as there was another suggestion), anyone can open up the two files and do a copy-paste between them, so that means everything supports it. I don't think the ability to do cut-paste qualifies as supporting AGENTS.md.

It can probably be listed as a way to make it work, just not a very good one.

If you aren't interesting in splitting the difference for the configuration section, then I'm fine also putting the configuration instructions in there along side different potential work arounds. So would be happy to merge as is (although not up to me :-)

(Where I would strongly object is if you try to add Claude to the list of supporting tools -- the current PR even wants to put it first in the list -- that's just wrong; the existence of cut-and-paste (or file copy) does not qualify a tool as supporting.)

[coolxeo]

my guess is that Claude is working already on it