Conversation
AGENTS.md is the vendor-neutral convention for agent instructions, read directly by Cursor, Copilot, Codex and others. It routes to the existing README and developer docs rather than restating them, and records the constraints that are not discoverable from the code alone. Claude Code can read AGENTS.md directly on recent versions, but only when no CLAUDE.md is present, and not at all on older versions or third-party providers. The one-line CLAUDE.md import makes it reach every session either way. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Adds an
AGENTS.md— the vendor-neutral convention for agent instructions, read directly by Cursor,Copilot, Codex and around twenty other tools — plus a one-line
CLAUDE.mdthat imports it.It deliberately routes to the existing README and developer docs rather than restating them, so it
should not go stale as those change. What it adds is the context that is not discoverable from the
code alone.
Why the bridge file. Recent Claude Code versions read
AGENTS.mddirectly, but only when noCLAUDE.mdis present at or above the working directory, and not at all on older versions, onthird-party providers such as Amazon Bedrock, or with telemetry or hooks disabled. The two-line
CLAUDE.mdmakesAGENTS.mdreach every session regardless. A symlink is the documentedalternative but needs Administrator privileges or Developer Mode on Windows.
Part of a wider pass adding these across the Shimmer repos. Corrections welcome — particularly from
anyone who works in this repo day to day, since I have read it rather than worked in it.
🤖 Generated with Claude Code