Skip to content

feat: update agent-ready to support AGENTS.md with CLAUDE.md symlink#30

Merged
dgalarza merged 2 commits intomainfrom
claude/update-agents-md-setup
Mar 17, 2026
Merged

feat: update agent-ready to support AGENTS.md with CLAUDE.md symlink#30
dgalarza merged 2 commits intomainfrom
claude/update-agents-md-setup

Conversation

@Claude
Copy link
Copy Markdown
Contributor

@Claude Claude AI commented Mar 17, 2026

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-md mode to agents-md. Updated all references from CLAUDE.md to AGENTS.md. Added symlink creation logic that migrates existing CLAUDE.md files and creates ln -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-md mode 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.md as the canonical file (works with any agent)
  • CLAUDE.md → AGENTS.md symlink (Claude Code compatibility)
  • Single source of truth with cross-agent compatibility

Existing CLAUDE.md-only repos are automatically migrated to this structure when the skill runs.

Original prompt

This section details on the original issue you should resolve

<issue_title>agent-ready create AGENTS.md</issue_title>
<issue_description>agent-ready should not be specific to just Claude Code. Instead we should bootstrap a repo to support other coding agents as well, specifically those that support AGENTS.md. Symlink CLAUDE.md to AGENTS.md as part of the set up process.</issue_description>

Comments on the Issue (you are @claude[agent] in this section)

Co-authored-by: dgalarza <105694+dgalarza@users.noreply.github.com>
@Claude Claude AI changed the title [WIP] Add AGENTS.md to support multiple coding agents feat: update agent-ready to support AGENTS.md with CLAUDE.md symlink Mar 17, 2026
@Claude Claude AI requested a review from dgalarza March 17, 2026 14:25
@dgalarza dgalarza marked this pull request as ready for review March 17, 2026 14:45
@dgalarza dgalarza merged commit 35f771f into main Mar 17, 2026
2 checks passed
@dgalarza dgalarza deleted the claude/update-agents-md-setup branch March 17, 2026 14:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

agent-ready create AGENTS.md

2 participants