# EneUI, conventions for coding agents

Read this before writing JSX against this catalogue. It states the addressing
scheme, the tool order, the content tiers and the naming rules, so generated
code matches the rest of the project.

## 1. What this is

A measured catalogue of UI components, blocks and icons. Every record carries
its source, declared licence, dependencies and install command. Reads are free;
installing a `commercial` or `pro` library needs a paid plan.

## 2. Addressing

| Entity | Form | Example |
| --- | --- | --- |
| Component | `library/name` | `magicui/animated-button` |
| Block | `source/name` | `shadcn/hero-01` |
| Design system | slug | `minimal-dark` |
| Page | absolute path | `/blocks/category/pricing` |

Slugs are kebab-case. Component ids never include spaces or version numbers.

## 3. Tool order

1. `get_design_system`, load tokens before writing any style.
2. `search_components` or `search_blocks`, search by the job, not the name.
3. `get_component` / `get_block`, read one record, including dependencies.
4. `compose_page`, when the task is a page, not a component.
5. `get_page`, read any page as Markdown when you need prose, not a record.

## 4. Install

```bash
npx eneui add <library>/<name>
```

Components are copied into the repository; the library is not a runtime
dependency. Follow the install command returned by the tool instead of
inventing a registry URL.

## 5. Styling

Apply the design-system CSS variables first, then Tailwind semantic tokens
(`bg-background`, `text-foreground`, `border-border`). Do not hardcode hex
values, and do not introduce a second accent colour.

## 6. Tiers

`open` (MIT/Apache/ISC) is always available. `commercial` and `pro` return
metadata on every plan and the install command only on a paid plan. Never
reproduce the source of a gated record.

## 7. Machine formats

- `https://ui.eneawork.it/llms.txt`, index for assistants
- `https://ui.eneawork.it/llms-full.txt`, the whole catalogue as one document
- `https://ui.eneawork.it/agent-skill.md`, tool sequence
- `https://ui.eneawork.it/sitemap.xml`, crawl map
- Append `.md` to any page URL for its Markdown twin

## 8. Limits

Rate limits answer `429` with `Retry-After`. Bulk mirroring is not allowed;
installing, quoting and indexing are. Terms: https://ui.eneawork.it/terms