Skip to content

chore: invert CLAUDE.md/AGENTS.md so AGENTS.md is canonical#9560

Merged
jdx merged 1 commit intomainfrom
chore/claude-md-symlink-agents
May 3, 2026
Merged

chore: invert CLAUDE.md/AGENTS.md so AGENTS.md is canonical#9560
jdx merged 1 commit intomainfrom
chore/claude-md-symlink-agents

Conversation

@jdx
Copy link
Copy Markdown
Owner

@jdx jdx commented May 3, 2026

Summary

  • Makes AGENTS.md the canonical project agents file (was a symlink to CLAUDE.md)
  • Replaces CLAUDE.md with a symlink to AGENTS.md (was the canonical file)

Test plan

  • readlink CLAUDE.md resolves to AGENTS.md
  • AGENTS.md is a regular file with the project instructions

🤖 Generated with Claude Code


Note

Low Risk
Low risk: documentation/agent-guidance file swap only, with no runtime code changes. Main risk is minor tooling disruption if symlink handling differs across environments.

Overview
Makes AGENTS.md the canonical repository agent guide by moving the full guidance content there.

Replaces CLAUDE.md with a lightweight pointer/symlink to AGENTS.md to preserve compatibility with tooling that expects CLAUDE.md.

Reviewed by Cursor Bugbot for commit 1db9798. Bugbot is set up for automated code reviews on this repo. Configure here.

@jdx jdx merged commit 05407dd into main May 3, 2026
27 checks passed
@jdx jdx deleted the chore/claude-md-symlink-agents branch May 3, 2026 12:22
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request renames the repository agent guide from CLAUDE.md to AGENTS.md, establishing AGENTS.md as the canonical file while maintaining CLAUDE.md as a pointer for compatibility. Feedback was provided to update the introductory text in AGENTS.md, which currently incorrectly describes the symlink relationship between the two files.

I am having trouble creating individual review comments. Click here to see my feedback.

AGENTS.md (3)

medium

The description in this line is now outdated. Since AGENTS.md is now the canonical file and CLAUDE.md is the symlink, the text should be updated to reflect the inversion.

This file provides guidance to AI coding agents when working with code in this repository. It is the canonical agents file, and CLAUDE.md symlinks to it for compatibility with existing tooling.

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 3, 2026

Greptile Summary

This PR inverts the symlink relationship between AGENTS.md and CLAUDE.md: AGENTS.md is now the canonical file (with the full guide content) and CLAUDE.md is a symlink pointing to it. The file content is unchanged, but the introductory sentence in AGENTS.md still describes the old arrangement — it says CLAUDE.md is canonical and AGENTS.md symlinks to it, which is now backwards.

Confidence Score: 4/5

Safe to merge after fixing the stale self-description sentence in AGENTS.md

One P1 finding: the introductory paragraph in AGENTS.md still describes CLAUDE.md as canonical, which is now incorrect and will mislead AI agents reading the file. No code changes; the structural inversion is correct.

AGENTS.md line 3 — stale introductory sentence

Important Files Changed

Filename Overview
AGENTS.md Promoted from symlink to canonical file; content is identical to old CLAUDE.md except the introductory sentence still incorrectly describes CLAUDE.md as canonical
CLAUDE.md Demoted from canonical file to a symlink pointing to AGENTS.md — correctly reflects the new arrangement

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    subgraph Before["Before (old)"]
        CL1["CLAUDE.md\n(canonical file)"]
        AG1["AGENTS.md\n(symlink → CLAUDE.md)"]
        AG1 -->|symlink| CL1
    end

    subgraph After["After (this PR)"]
        AG2["AGENTS.md\n(canonical file)"]
        CL2["CLAUDE.md\n(symlink → AGENTS.md)"]
        CL2 -->|symlink| AG2
    end
Loading

Comments Outside Diff (1)

  1. AGENTS.md, line 3 (link)

    P1 Stale self-description after symlink inversion

    The opening sentence still describes the old arrangement (CLAUDE.md as canonical, AGENTS.md as the symlink), but this PR inverts that relationship. Any AI agent reading this file will get incorrect information about which file is canonical.

    Fix in Claude Code

Fix All in Claude Code

Reviews (1): Last reviewed commit: "chore: invert CLAUDE.md/AGENTS.md so AGE..." | Re-trigger Greptile

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 3, 2026

Hyperfine Performance

mise x -- echo

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2026.4.28 x -- echo 23.6 ± 0.5 22.5 28.3 1.00
mise x -- echo 24.4 ± 1.2 23.3 43.7 1.03 ± 0.05

mise env

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2026.4.28 env 23.4 ± 0.7 22.2 29.6 1.00
mise env 23.9 ± 0.4 22.8 26.8 1.02 ± 0.04

mise hook-env

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2026.4.28 hook-env 23.7 ± 0.4 22.8 25.3 1.00
mise hook-env 24.4 ± 0.9 23.1 39.7 1.03 ± 0.04

mise ls

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2026.4.28 ls 20.5 ± 0.4 19.5 21.7 1.00
mise ls 21.6 ± 0.5 20.1 23.7 1.05 ± 0.03

xtasks/test/perf

Command mise-2026.4.28 mise Variance
install (cached) 157ms 162ms -3%
ls (cached) 79ms 81ms -2%
bin-paths (cached) 83ms 85ms -2%
task-ls (cached) 847ms 816ms +3%

mise-en-dev added a commit that referenced this pull request May 3, 2026
### 🚀 Features

- **(conda)** graduate conda backend out of experimental by @jdx in
[#9544](#9544)
- **(deps)** Add dart and flutter providers by @tjarvstrand in
[#9505](#9505)
- **(registry)** add neo4j by @mnm364 in
[#9525](#9525)
- **(registry)** add rustfs by @mnm364 in
[#9530](#9530)
- **(task)** support exclusion patterns in task sources by
@jlarmstrongiv in [#9496](#9496)
- **(vfox)** add stat function to lua file module by @esteve in
[#9497](#9497)

### 🐛 Bug Fixes

- **(backend)** flag regex prerelease versions by @jdx in
[#9500](#9500)
- **(backend)** mark -nightly/-canary/-experimental as prereleases by
@jdx in [#9523](#9523)
- **(backend)** suppress no-versions warning for unresolved-latest
backends by @jdx in [#9548](#9548)
- **(backend)** include dotnet prereleases from package flags by @jdx in
[#9551](#9551)
- **(backend)** scope PEP 440 prerelease detection to Python backends by
@jdx in [#9558](#9558)
- **(cargo)** Apply install_env during cargo install by @c22 in
[#9502](#9502)
- **(copr)** drop epel-9 chroots since rust >= 1.91 is unavailable by
@jdx in [#9484](#9484)
- **(github)** skip attestations on non-default api_url by @jdx in
[#9486](#9486)
- **(github)** retry ip allow list errors without auth by @risu729 in
[#9506](#9506)
- **(http)** update versions host tracking endpoint by @jdx in
[#9527](#9527)
- **(install)** don't warn for configured tools when version is passed
via CLI by @jdx in [#9522](#9522)
- **(install)** refresh latest before installing missing tools by @jdx
in [#9545](#9545)
- **(install)** don't cache nonexistent install paths by @jdx in
[#9553](#9553)
- **(lockfile)** don't propagate ad-hoc CLI overrides into the project
lockfile by @jdx in [#9562](#9562)
- **(plugin)** detect plugin types after cloning by @risu729 in
[#9540](#9540)
- **(release)** pass --no-git-checks to aube publish by @jdx in
[#9483](#9483)
- **(task)** convert PATH to MSYS Unix form when spawning POSIX shells
on Windows by @JamBalaya56562 in
[#9547](#9547)

### 📚 Documentation

- **(contributing)** require popularity check for registry PRs by @jdx
in
[7bbeebe](7bbeebe)
- **(watch)** update pitchfork domain to en.dev by @risu729 in
[#9536](#9536)
- document ghtkn GitHub token setup by @jdx in
[#9546](#9546)
- clarify registry backend acceptance policy by @jdx in
[#9543](#9543)
- Change exec command to use bash for variable echo by @kuboon in
[#9567](#9567)

### 🧪 Testing

- **(e2e)** run test-tool targets in parallel by @jdx in
[#9564](#9564)
- **(e2e)** run tests in parallel by @jdx in
[#9563](#9563)
- **(e2e)** bind-mount /tmp on disk and surface failed tests in CI
summary by @jdx in [#9570](#9570)
- **(tasks)** migrate test_task_help atask to usage field by @jdx in
[#9549](#9549)

### 📦️ Dependency Updates

- update fedora:45 docker digest to 8b838b3 by @renovate[bot] in
[#9507](#9507)
- update ghcr.io/jdx/mise:deb docker digest to f02194c by @renovate[bot]
in [#9509](#9509)
- update taiki-e/install-action digest to 7769b73 by @renovate[bot] in
[#9512](#9512)
- update ghcr.io/jdx/mise:alpine docker digest to 581f8a8 by
@renovate[bot] in [#9508](#9508)
- update rust crate ctor to v0.10.1 by @renovate[bot] in
[#9515](#9515)
- update ghcr.io/jdx/mise:rpm docker digest to a5c9655 by @renovate[bot]
in [#9510](#9510)
- update rust docker digest to a9cfb75 by @renovate[bot] in
[#9511](#9511)
- update rust crate age to v0.11.3 by @renovate[bot] in
[#9514](#9514)
- update rust crate jiff to v0.2.24 by @renovate[bot] in
[#9516](#9516)
- update dependency vitepress-plugin-tabs to ^0.9.0 by @renovate[bot] in
[#9518](#9518)
- update autofix-ci/action action to v1.3.4 by @renovate[bot] in
[#9513](#9513)
- update rust crate usage-lib to v3.2.1 by @renovate[bot] in
[#9517](#9517)
- update apple-actions/import-codesign-certs action to v7 by
@renovate[bot] in [#9519](#9519)
- update taiki-e/install-action digest to 51cd0b8 by @renovate[bot] in
[#9531](#9531)
- exclude taiki-e/install-action from renovate by @jdx in
[#9532](#9532)
- update rust crate blake3 to v1.8.5 by @renovate[bot] in
[#9533](#9533)

### 📦 Registry

- enable shellcheck on windows by @zeitlinger in
[#9487](#9487)
- add google-java-format by @zeitlinger in
[#9488](#9488)
- add expert
([aqua:expert-lsp/expert](https://github.com/expert-lsp/expert)) by
@AlternateRT in [#9498](#9498)
- update entry for checkmake by @eread in
[#9504](#9504)
- add systemctl-tui
([aqua:rgwood/systemctl-tui](https://github.com/rgwood/systemctl-tui))
by @2xdevv in [#9521](#9521)
- add codon by @3w36zj6 in
[#9538](#9538)
- add tool yr (backend:github:VirusTotal/yara-x) by @adam-moss in
[#9542](#9542)
- add tool betterleaks (backend:aqua/betterleaks/betterleaks) by
@adam-moss in [#9541](#9541)
- add `git-filter-repo` by @garysassano in
[#9550](#9550)
- add umoci
([aqua:opencontainers/umoci](https://github.com/opencontainers/umoci))
by @2xdevv in [#9555](#9555)
- add aqua backend for elixir-ls by @AlternateRT in
[#9557](#9557)
- deny inline backend options by @risu729 in
[#9565](#9565)

### Chore

- **(ci)** fail registry tests without summary by @jdx in
[#9559](#9559)
- **(ci)** use !cancelled() instead of always() for test-ci aggregator
by @jdx in [#9569](#9569)
- **(ci)** use namespace runners for ci jobs by @jdx in
[#9561](#9561)
- **(config)** deprecate shorthands_file setting by @risu729 in
[#9534](#9534)
- **(docs)** remove shrill.en.dev analytics script by @jdx in
[#9539](#9539)
- **(release)** replace bc with awk in release-plz star formatting by
@jdx in
[d7f177f](d7f177f)
- bump hk to 1.44.3 by @jdx in
[#9493](#9493)
- invert CLAUDE.md/AGENTS.md so AGENTS.md is canonical by @jdx in
[#9560](#9560)
- set dev profile debug to 1 by @jdx in
[#9572](#9572)

### New Contributors

- @kuboon made their first contribution in
[#9567](#9567)
- @AlternateRT made their first contribution in
[#9557](#9557)
- @2xdevv made their first contribution in
[#9555](#9555)
- @adam-moss made their first contribution in
[#9541](#9541)
- @jlarmstrongiv made their first contribution in
[#9496](#9496)
- @tjarvstrand made their first contribution in
[#9505](#9505)
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.

1 participant