Skip to content
Agent Friendly Code

AGENTS.md generator: draft one from your repo

Paste a public GitHub repo link. If the repo has no AGENTS.md or CLAUDE.md, its score page includes a starter AGENTS.md drafted from what the scan finds, ready to copy. Free, no signup.

What goes in the draft

  • A first line naming the repo, with its description's first sentence and main language.
  • Where things are: the dependency manifest, tests, lint and type config, CI, commit hooks, dev setup and CONTRIBUTING guide, each only if the scan found it.
  • A Commands section with Install, Test and Lint left as TODO.

What it leaves to you

The scan records where a file is, not what it runs, so the draft never guesses a command. Copy the exact install, test and lint commands from your CI, then add the rules a reviewer keeps repeating. What to put in an AGENTS.md.

Example: the draft for psf/requests

The highest-scoring repo on the leaderboard without a usable AGENTS.md or CLAUDE.md. Its score →

# AGENTS.md

Guidance for AI coding agents working in psf/requests. A simple, yet elegant, HTTP library. Written mainly in Python.

## Where things are

- Dependencies are declared in `pyproject.toml`.
- Tests live in `tests`.
- Lint and format rules are configured in `pyproject.toml`.
- Type checking is configured in `pyproject.toml`.
- CI is defined in `.github/workflows`; read it for the exact install, lint and test steps.
- Commit hooks are set up in `.pre-commit-config.yaml`; don't skip them.
- Common tasks are targets in `Makefile`.
- Follow the conventions in `.github/CONTRIBUTING.md`.

## Commands

<!-- Fill in the exact commands CI runs. -->
- Install: TODO
- Test: TODO
- Lint: TODO

Do I also need a CLAUDE.md, GEMINI.md or Copilot file?

Keep one AGENTS.md. Gemini CLI needs a setting to read it, and Claude Code an import if you also keep a CLAUDE.md; Copilot, Cursor and Codex read it as is. AGENTS.md vs CLAUDE.md.

  • Claude Code · CLAUDE.mdFrom v2.1.277 it reads AGENTS.md itself, but only when there is no CLAUDE.md. If you keep one, have it import AGENTS.md; that never loads the file twice. Docs for Claude Code (new tab)
    @AGENTS.md
    
  • Gemini CLI · .gemini/settings.jsonReads GEMINI.md by default. List AGENTS.md in context.fileName in a committed project settings file. Docs for Gemini CLI (new tab)
    {
      "context": {
        "fileName": [
          "AGENTS.md",
          "GEMINI.md"
        ]
      }
    }
    
  • GitHub CopilotIts cloud agent, code review and CLI read AGENTS.md. No extra file needed. Docs for GitHub Copilot (new tab)
  • CursorReads AGENTS.md at the root and in subdirectories. Add .cursor/rules/*.mdc only for rules scoped to some files. Docs for Cursor (new tab)
  • CodexReads AGENTS.md before any work. No extra file needed. Docs for Codex (new tab)