AGENTS.md预览
为 AI 编码代理下载 HeroUI v3 React 文档
将 HeroUI v3 React 文档直接下载到你的项目中，供 AI 助手参考。
注意： agents-md 命令专门用于 HeroUI React v3。其他 CLI 命令（如 add、init、upgrade 等）目前仍用于 HeroUI v2。
用法
npx heroui-cli@latest agents-md --react或者指定输出文件：
npx heroui-cli@latest agents-md --react --output AGENTS.md功能说明
- 将最新的 HeroUI v3 React 文档下载到
.heroui-docs/react/ - 在
AGENTS.md或CLAUDE.md中生成索引 - 包含用于代码示例的 demo 文件
- 自动将
.heroui-docs/添加到.gitignore
选项
--react— 仅下载 React 文档--output <files...>— 目标文件（例如AGENTS.md，或AGENTS.md CLAUDE.md）--ssh— 使用 SSH 进行 git clone
环境要求
- Tailwind CSS >= v4
- React >= 19.0.0
@heroui/react >= 3.0.0或@latest
相关文档
- AGENTS.md — 了解面向编码代理的 AGENTS.md 格式
- CLAUDE.md — Claude 对应版本的 AGENTS.md
- AGENTS.md vs Skills — AGENTS.md 的性能表现