AGENTS.mdPreview
Download HeroUI v3 React documentation for AI coding agents
Download HeroUI v3 React documentation directly into your project for AI assistants to reference.
Use agents-md --react to download HeroUI React v3 documentation. The CLI also supports initializing projects and installing, upgrading, and uninstalling v3 packages. To install reusable agent skills, follow the Agent Skills guide.
Usage
npx heroui-cli@latest agents-md --reactOr specify output file:
npx heroui-cli@latest agents-md --react --output AGENTS.mdWhat It Does
- Downloads latest HeroUI v3 React docs to
.heroui-docs/react/ - Generates an index in
AGENTS.mdorCLAUDE.md - Includes demo files for code examples
- Adds
.heroui-docs/to.gitignoreautomatically
Options
--react- Download React docs only--output <files...>- Target file(s) (e.g.,AGENTS.mdorAGENTS.md CLAUDE.md)--ssh- Use SSH for git clone
Requirements
- Tailwind CSS >= v4
- React >= 19.0.0
@heroui/react >= 3.0.0or@latest
Related Documentation
- AGENTS.md - Learn about the AGENTS.md format for coding agents
- CLAUDE.md - Claude equivalent of AGENTS.md
- AGENTS.md vs Skills - AGENTS.md performance