init-agents-md
Installation
SKILL.md
Initialize AGENTS.md
Create a short, repo-specific AGENTS.md. Inspect the repository first, keep only the facts that help an agent work faster, treat AGENTS.md as the canonical context file, and ensure CLAUDE.md is a symlink to AGENTS.md.
Read references/agents-md-best-practices.md before drafting.
Workflow
- Check the current files.
- If
AGENTS.mdalready exists, stop. Tell the user and ask whether to continue and overwrite it. - If
CLAUDE.mdexists and is a regular file (not a symlink), read it and use it as seed material for the newAGENTS.md. - If
CLAUDE.mddoes not exist or is already a symlink, plan to symlink it after creatingAGENTS.md.
- Explore the repository.
- Inspect only enough to explain the real project shape and workflows.
- Start with root files and directories, using the
READMEas an initial guide to understand the project. - Look for the commands people actually run, where the important code lives, whether tests exist, and any sharp edges an agent could miss.
- Prefer
rg,rg --files,ls, and targeted file reads over broad dumps.