ContextQMD
Back to Heroui

AGENTS.md

apps/docs/content/docs/react/migration/(migration-for-agents)/agents-md.mdx

3.0.41.6 KB
Original Source

Download HeroUI v2 to v3 migration documentation directly into your project for AI assistants to reference.

<Callout> **Note:** The `agents-md --migration` command downloads migration docs only. Use `--react` for component documentation. Only one library option is supported at a time. </Callout>

Usage

bash
npx heroui-cli@latest agents-md --migration

Or specify output file:

bash
npx heroui-cli@latest agents-md --migration --output AGENTS.md

What It Does

  • Downloads migration docs to .heroui-docs/migration/
  • Generates an index in AGENTS.md or CLAUDE.md with migration-specific content
  • Includes workflow guides (full and incremental), component migration guides, hooks, and styling
  • Adds .heroui-docs/ to .gitignore automatically

Options

  • --migration - Download migration docs only (v2 to v3)
  • --output <files...> - Target file(s) (e.g., AGENTS.md or AGENTS.md CLAUDE.md)
  • --ssh - Use SSH for git clone

Requirements

Migration docs are useful for any project migrating from HeroUI v2 to v3. The target project needs:

  • Tailwind CSS >= v4
  • React >= 19.0.0 (for v3)
  • @heroui/react or @heroui/styles (after migration)