What the AGENTS.md generator does
Paste a public GitHub repository URL and this tool drafts an AGENTS.md for it, the file that tells AI coding agents how to work in your project. It reads your README, package manifests (like package.json, requirements.txt, go.mod or Cargo.toml) and folder structure, then writes a tailored guide with real setup, build and test commands. It also produces a matching CLAUDE.md.
Why AGENTS.md matters
AI coding agents work far better when a repository tells them how it is built and run. AGENTS.md became the shared convention for exactly that in 2025-2026, adopted across many AI coding tools. Think of it as a README written for agents: setup steps, the commands to build and test, the project's structure, and the conventions to follow. A good AGENTS.md means fewer wrong guesses and cleaner contributions from any agent that reads it.
How to use it
- Paste a public GitHub repo URL (for example
github.com/owner/repo) and press Generate. - Review the draft under the AGENTS.md tab, and the companion CLAUDE.md under its tab.
- Copy or download the file.
- Commit it to your repo root as
AGENTS.md(andCLAUDE.mdif you use Claude Code).
AGENTS.md vs CLAUDE.md
- AGENTS.md is the tool-agnostic file most AI agents look for. Keep your full project guide here.
- CLAUDE.md is Claude Code's own guidance file. The tidy pattern, and the one this tool uses, is to make CLAUDE.md a short file that imports AGENTS.md with
@AGENTS.md, so you maintain a single source of truth.
Good to know
- The draft is generated from public repo signals, so always review and edit it before committing. Add the gotchas only you know.
- It works on any public repository, so you can generate one for a project you are learning, not just your own.
- Private repositories are not supported, the tool only uses the public GitHub API.