## π Getting Started
[![][pnpm-shield]][pnpm-link]
```bash
$ pnpm add @lobehub/ui @lobehub/icons @lobehub/fluent-emoji motion
```
Lobe UI is ESM only and needs React 19, `motion` 13 or 14, `@lobehub/icons` 6 and `@lobehub/fluent-emoji` 5 as peer dependencies.
```tsx
import '@lobehub/ui/theme.css';
import '@lobehub/ui/style.css';
import { Button, ConfigProvider } from '@lobehub/ui';
import { motion } from 'motion/react';
export default () => (
);
```
Theming, i18n, CSS layers and framework setup are covered in the [documentation](https://ui.lobehub.com). Upgrading from 5.x? v6 drops Ant Design; follow the [v6 migration guide](https://ui.lobehub.com/migration-v6).
[![][back-to-top]](#readme-top)
## π€ AI-Powered Development
Lobe UI's docs are generated for coding agents as well as people.
| Resource | What it does |
| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| [skills.md](https://ui.lobehub.com/skills.md) | Agent skill entry point with a Markdown reference (usage, props, API) for every component |
| [llms.txt](https://ui.lobehub.com/llms.txt) | Page index with outlines for [llms.txt](https://llmstxt.org)-aware tools |
| [v6 migration skill](https://github.com/lobehub/lobe-ui/tree/master/.agents/skills/lobe-ui-v6-migration) | `npx skills add lobehub/lobe-ui`: lets your agent upgrade a 5.x app |
| [Codemod](https://github.com/lobehub/lobe-ui/tree/master/packages/codemod) | `npx @lobehub/ui-codemod@latest v6 . --dry`: rewrites v5 code and writes a JSON report agents can work through |
Paste this into Cursor, Claude Code, Codex or any other coding agent:
```text
Read https://ui.lobehub.com/skills.md, then use @lobehub/ui to build a chat page with a message list and an input box. Only use components, props and imports documented there.
```
Works with Cursor, Claude Code, Windsurf, GitHub Copilot and other llms.txt-aware tools.
## π Documentation
- **Docs and live demos**: [ui.lobehub.com](https://ui.lobehub.com)
- **Migrating to v6**: [ui.lobehub.com/migration-v6](https://ui.lobehub.com/migration-v6)
- **Changelog**: [CHANGELOG.md](./CHANGELOG.md)
[![][back-to-top]](#readme-top)
## π¬ Community
Questions, ideas and showcases are all welcome:
- [Discord][discord-link]
- [GitHub Discussions](https://github.com/lobehub/lobe-ui/discussions)
- [GitHub Issues][github-issues-link]
[![][back-to-top]](#readme-top)
## β¨οΈ Local Development
You can use Github Codespaces for online development:
[![][codespaces-shield]][codespaces-link]
Or clone it for local development (Node.js >= 22.22 and pnpm):
```bash
$ git clone https://github.com/lobehub/lobe-ui.git
$ cd lobe-ui
$ pnpm install
$ pnpm start
```
[![][back-to-top]](#readme-top)
## π€ Contributing
Contributions of all types are more than welcome, if you are interested in contributing code, feel free to check out our GitHub [Issues][github-issues-link] to get stuck in to show us what youβre made of.
[![][pr-welcome-shield]][pr-welcome-link]
[![][contributors-contrib]][contributors-link]
