# AGENTS.md · HeroUI

> Download HeroUI v3 React documentation for AI coding agents

- Page: https://jiguang132.com/systems/heroui/docs/getting-started/agents-md
- Based on: HeroUI documentation (Apache-2.0) @ 60edd8ed751b1d2a270623fbb182bbcfa8baa9af

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

```bash
npx heroui-cli@latest agents-md --react
```

Or specify output file:

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

### What It Does

- Downloads latest HeroUI v3 React docs to `.heroui-docs/react/`
- Generates an index in `AGENTS.md` or `CLAUDE.md`
- Includes demo files for code examples
- Adds `.heroui-docs/` to `.gitignore` automatically

### Options

- `--react` - Download React docs only
- `--output <files...>` - Target file(s) (e.g., `AGENTS.md` or `AGENTS.md CLAUDE.md`)
- `--ssh` - Use SSH for git clone

### Requirements

- Tailwind CSS >= v4
- React >= 19.0.0
- `@heroui/react >= 3.0.0` or `@latest`

### Related Documentation

- [AGENTS.md](https://agents.md/) - Learn about the AGENTS.md format for coding agents
- [CLAUDE.md](https://code.claude.com/docs/en/best-practices#write-an-effective-claude-md) - Claude equivalent of AGENTS.md
- [AGENTS.md vs Skills](https://vercel.com/blog/agents-md-outperforms-skills-in-our-agent-evals) - AGENTS.md performance

---

Index of all JGuang resources: https://jiguang132.com/llms.txt