feat: update agent-ready to support AGENTS.md with CLAUDE.md symlink#30
Merged
feat: update agent-ready to support AGENTS.md with CLAUDE.md symlink#30
Conversation
Co-authored-by: dgalarza <105694+dgalarza@users.noreply.github.com>
dgalarza
approved these changes
Mar 17, 2026
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
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.
The agent-ready plugin was Claude Code-specific. Updated to generate AGENTS.md as the primary documentation file (compatible with any AI coding agent), with CLAUDE.md as a symlink for backward compatibility.
Changes
SKILL.md: Renamed
claude-mdmode toagents-md. Updated all references from CLAUDE.md to AGENTS.md. Added symlink creation logic that migrates existing CLAUDE.md files and createsln -sf AGENTS.md CLAUDE.md. Enhanced audit mode to validate symlink correctness.claude-md-template.md: Updated template header to generate AGENTS.md. Added note explaining CLAUDE.md symlink relationship. Template filename unchanged to avoid breaking references.
README.md: Added "AGENTS.md vs CLAUDE.md" section explaining the approach. Updated modes table to reflect
agents-mdmode and symlink creation.plugin.json & marketplace.json: Bumped version to 1.1.0. Updated descriptions to mention both AGENTS.md and CLAUDE.md symlink. Added "agents-md" keyword.
Result
When users run agent-ready, they get:
AGENTS.mdas the canonical file (works with any agent)CLAUDE.md → AGENTS.mdsymlink (Claude Code compatibility)Existing CLAUDE.md-only repos are automatically migrated to this structure when the skill runs.
Original prompt