registry — правило для Claude Code: что делает и как установить
Правило registry для Claude Code описывает публикацию UI-компонентов как исходного кода. Оно задаёт формат метаданных и шаги размещения реестра.
Apache-2.0 ★ 141 обновлён 2026-11-17
.claude/rules/registry.mdЧто делает registry
Правило registry описывает реестры, которые отдают проекту исходный код компонентов вместо собранного пакета. Оно объясняет разницу между registry и npm, показывает импорт локального компонента и перечисляет поля JSON: зависимости, registryDependencies, файлы и категорию.
Для публикации создаётся каталог с JSON в public/, настраиваются заголовки в vercel.json, затем выполняется vercel --prod. Установка компонента выполняется через npx shadcn@latest add с адресом JSON. Запись без зависимостей, связанных компонентов, файлов или категории считается неполной.
Какие задачи решает
- описать отличие registry от npm-пакета
- сформировать JSON-метаданные UI-компонента
- настроить публикацию реестра через
vercel.json - добавить компонент через
npx shadcn@latest add
Примеры запросов агенту
- Опиши, чем registry отличается от npm для UI-компонентов.
- Проверь JSON реестра для
metric-cardи найди недостающие поля. - Составь шаги публикации компонента через
vercel.jsonиvercel --prod.
Как установить registry
Вручную: положить файлы
.claude/rules/registry.mdПоле paths во frontmatter ограничивает файлы
AGENTS.md
Codex читает AGENTS.md: вставьте текст правила туда
Вручную: положить файлы
.cursor/rules/registry.mdcВо frontmatter: description, globs, alwaysApply
Вручную: положить файлы
.github/instructions/registry.instructions.mdПоле applyTo задаёт, к каким файлам применять
Вручную: положить файлы
.devin/rules/registry.mdВручную: положить файлы
.clinerules/registry.mdПо шагам, с командами для каждой платформы: AGENTS.md и CLAUDE.md: что это, кто читает и какой выбрать
Вопросы о registry
Как установить registry в Claude Code?
Разместите файл правила по пути .claude/rules/registry.md.
Что делает registry?
Правило описывает распространение компонентов в виде исходного кода. Оно задаёт структуру JSON для зависимостей, связанных элементов, файлов и категории, а также показывает публикацию через Vercel и установку через npx shadcn@latest add.
Какие поля нужны в JSON реестра компонента?
Запись включает name, type, description, dependencies, registryDependencies, files и category. В files указываются тип, путь и содержимое файла.
Исходный текст
registry.md · Apache-2.0
---
title: Component Registries
impact: LOW
impactDescription: Source code distribution
tags: registry, shadcn, distribution, cli, source-code
---
## Component Registries
Registries distribute **source code**, not compiled packages. This enables true component ownership and customization.
### Core Concept
**Bad:**
```typescript
// Traditional npm - compiled dependency
import { Button } from "some-ui-library";
```
**Good:**
```typescript
// Registry-based - source code in your project
import { Button } from "@/components/ui/button";
```
### Registry Metadata Format
**Bad:**
```json
{
"name": "announcement",
"type": "registry:component",
"description": "A compound badge component"
// Missing dependencies, registryDependencies, files, and category
}
```
**Good:**
```json
{
"name": "announcement",
"type": "registry:component",
"description": "A compound badge component",
"dependencies": ["class-variance-authority", "lucide-react"],
"registryDependencies": ["badge"],
"files": [
{
"type": "registry:component",
"path": "announcement.tsx",
"content": "..."
}
],
"category": "ui"
}
```
### Quick Publishing
**1. Create structure:**
```
my-component/
├── public/
│ └── metric-card.json
└── vercel.json
```
**2. Configure headers (`vercel.json`):**
**Example:**
```json
{
"headers": [
{
"source": "/(.*).json",
"headers": [
{ "key": "Access-Control-Allow-Origin", "value": "*" },
{ "key": "Content-Type", "value": "application/json" }
]
}
]
}
```
**3. Deploy:**
**Example:**
```bash
vercel --prod
```
**4. Users install via:**
**Example:**
```bash
npx shadcn@latest add https://your-project.vercel.app/metric-card.json
```
### Component JSON Structure
**Example:**
```json
{
"name": "metric-card",
"type": "registry:component",
"description": "Display metrics with icon and trend",
"dependencies": ["lucide-react"],
"registryDependencies": ["card"],
"files": [
{
"type": "registry:component",
"path": "metric-card.tsx",
"content": "import { Card } from '@/components/ui/card'\n\nexport function MetricCard({ title, value }) {\n return <Card><h3>{title}</h3><p>{value}</p></Card>\n}"
}
],
"category": "ui"
}
```
### Registry vs npm
| Aspect | Registry | npm |
| ------------- | ----------------- | --------------- |
| Distribution | Source code | Compiled |
| Ownership | Full control | Dependency lock |
| Customization | Modify freely | Fork/override |
| Updates | Manual copy | `npm update` |
| Bundle size | Only what you use | Full package |
### Best Practices
**For Authors:**
1. Document dependencies
2. Version components
3. Provide examples
4. Test compatibility
5. Use semantic naming
**For Consumers:**
1. Review source code
2. Check dependencies
3. Customize freely
4. Track updates
5. Test thoroughly
### When to Use
**Use registries when:**
- Sharing with community
- Users need source ownership
- Building for specific frameworks
- Quick distribution needed
**Use npm when:**
- Distributing compiled code
- Need version management
- Framework-agnostic libraries
- Complex build processes
© maxtrigify · Apache-2.0 · maxtrigify/Otto