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.
Note: The agents-md command is specifically for HeroUI React v3. Other CLI commands (like add, init, upgrade, etc.) are for HeroUI v2 (for now).
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 >= 2.8.0,@beta, or@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