next-agents-md

Give AI coding agents (Claude, Cursor, etc.) access to Next.js documentation.

Why?

AI agents work better when they can reference up-to-date documentation instead of relying on training data. This tool downloads the official Next.js docs and creates a compact index that agents can use to look up the right documentation files.

Usage

Run in your Next.js project:

npx @judegao/next-agents-md

This will:

1. Detect your Next.js version
2. Download matching documentation to .next-docs/
3. Inject a docs index into your CLAUDE.md (or AGENTS.md)

Non-interactive mode

# Auto-detect version, output to CLAUDE.md
npx @judegao/next-agents-md --md CLAUDE.md

# Specify version explicitly
npx @judegao/next-agents-md --version 15.1.3 --md CLAUDE.md

Options

| Flag | Description | |------|-------------| | --version <version> | Next.js version (auto-detected if not provided) | | --md <path> | Target markdown file (default: CLAUDE.md) |

How it works

The tool injects a compressed index between <!-- NEXT-AGENTS-MD-START --> and <!-- NEXT-AGENTS-MD-END --> markers. This index tells the AI agent where to find documentation files in .next-docs/.

When working on Next.js tasks, the agent will read the relevant docs from .next-docs/ rather than relying on potentially outdated training data.

License

MIT