Skip to content

AGENTS.md Generator

Writes project-specific AGENTS.md and rule files by reading a codebase's real toolchain

Stars
49,023
Licence
MIT
Files
15 files

What it does

Once installed, the agent inspects your project (lockfiles, package.json scripts, config files, folder layout) and writes an AGENTS.md file plus optional .agents/rules/ files describing your real commands, architecture, and conventions, so other AI coding tools know how to work in the repo. It supports full, minimal, update, and dry-run (preview only) modes, and backs up existing files before changing them. Its instructions say to ask for approval before changing target files.

Great for

  • Maintainers of JavaScript/TypeScript projects who want an AGENTS.md that matches the actual stack instead of generic placeholders
  • Teams with monorepos or several AI coding tools (Claude, Cursor, Copilot, Codex) who need consistent instructions
  • People who want to preview changes first using dry-run mode

Skip it if

  • Projects where you have not reviewed the generated conventions: the skill can propose conventions, and generated guidance is not a substitute for human review (risk of inaccurate or invented rules)
  • Repositories with existing carefully curated agent rules you do not want touched: the skill can overwrite or update managed blocks, so use dry-run and check backups first
  • Environments where running repository scripts is not allowed: the skill is designed not to run project scripts by default, but a user could request execution, which runs repository-controlled code

Try asking

  • “Create a full AGENTS.md and rule files for this project”
  • “Preview what an AGENTS.md would look like without writing any files (dry-run)”
  • “Just make a minimal AGENTS.md with the basics”
  • “Update AGENTS.md because my stack changed from npm to Bun”
Step-by-step guide: how to use AGENTS.md GeneratorInstall, first run, examples, tips and FAQs

Install in 3 steps

  1. 1

    Download the skill

    The ZIP contains the 15 original files, the MIT licence and an attribution note.

    agents-generator.zip
  2. 2

    Add it to your agent

    Claude Code (all projects)

    mkdir -p ~/.claude/skills && unzip agents-generator.zip -d ~/.claude/skills/

    Claude Code / Agent SDK (this project only)

    mkdir -p .claude/skills && unzip agents-generator.zip -d .claude/skills/

    Claude apps (web/desktop): Settings → Capabilities → Skills → Upload skill, and choose the ZIP.

  3. 3

    Ask for the task

    No special command needed — the agent reads the skill's description and loads it when your request matches. Try one of the prompts above.

Get better results

  • Run a dry-run first to review detected package manager, commands and skipped rules before any file is written
  • Keep your existing AGENTS.md or CLAUDE.md under version control so you can diff and revert the changes
  • Check that generated commands match package.json scripts, and treat proposed new conventions as suggestions to approve, not facts

What's inside

  • assets/agents-full.md
  • assets/agents-minimal.md
  • assets/agents-nested.md
  • assets/architecture.md
  • assets/backend.md
  • assets/claude.md
  • assets/database.md
  • assets/forms.md
  • assets/frontend-patterns.md
  • assets/git-workflow.md
  • assets/i18n.md
  • assets/platform.md
  • assets/sdd-workflow.md
  • assets/server-actions.md
  • SKILL.md

Redistributed unmodified from sickn33/agentic-awesome-skills under the MIT licence. The assessment was drafted with AI from the skill's files on 2026-10-29. Skills can instruct your agent to run code — read SKILL.md and any scripts before installing.